POST api/workplan/{id}/tasks
Add Task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
Body Parameters
TasksRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| WorkTypeId | globally unique identifier |
None. |
|
| ParentTaskId | globally unique identifier |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| Assignments | Dictionary of globally unique identifier [key] and decimal number [value] |
None. |
|
| ProcessAssignments | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"WorkTypeId": "9d7973c0-6d6d-41d7-8a4d-83fc572fb727",
"ParentTaskId": "d06c6bd3-7b47-465e-ba91-70d6620b6c8a",
"Integration": {
"IntegrationId": "536f7567-0f19-4568-9262-6adcba90367f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"45c53af9-be09-4281-9cf0-83fd3ce2d62d": 2.0,
"5e618b1d-c7db-4c06-9dd7-e82659102394": 4.0
},
"ProcessAssignments": true
}
Response Information
Resource Description
WorkPlanTask| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Author | string |
None. |
|
| Editor | string |
None. |
|
| AssignedTo | Collection of globally unique identifier |
None. |
|
| NonLaborAssignments | Collection of TaskNonLaborAssignment |
None. |
|
| Assignments | Collection of TaskAssignment |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| WorkTypeParentId | globally unique identifier |
None. |
|
| WorkTypeIndex | integer |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| Index | integer |
None. |
|
| Complete | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| StartDate | date |
None. |
|
| DueDate | date |
None. |
|
| TaskScheduleType | TaskType |
None. |
|
| StatusUpdate | StatusUpdateClass |
None. |
|
| LastComment | date |
None. |
|
| IsScheduled | boolean |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "3d5b4beb-3eef-4867-968e-3b6c048c74d9",
"Name": "sample string 1",
"Created": "2026-10-29T18:28:05.0705037+00:00",
"Modified": "2026-10-29T18:28:05.0705037+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2825817d-9e19-4ac6-a4d8-817387330dcf",
"87cf4fb9-9d3f-4506-8cbd-83b52463f71a"
],
"NonLaborAssignments": [
{
"Id": "2150a661-a8fe-4f0e-b944-467ef0fdabe6",
"ResourceId": "1202ef78-1856-4f54-a3ff-f2818b5c3e8b",
"Quantity": 3.0
},
{
"Id": "2150a661-a8fe-4f0e-b944-467ef0fdabe6",
"ResourceId": "1202ef78-1856-4f54-a3ff-f2818b5c3e8b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7ef5321d-f11f-44a4-82d3-54e7b722c5d2",
"Type": 0,
"ResourceId": "477e5a6a-81f5-429b-9c48-4420c860e064",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "84c4573e-372a-412f-92a0-66f12cafc4ed",
"Start": "2026-10-29T18:28:05.0705037+00:00",
"Due": "2026-10-29T18:28:05.0705037+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "84c4573e-372a-412f-92a0-66f12cafc4ed",
"Start": "2026-10-29T18:28:05.0705037+00:00",
"Due": "2026-10-29T18:28:05.0705037+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7ef5321d-f11f-44a4-82d3-54e7b722c5d2",
"Type": 0,
"ResourceId": "477e5a6a-81f5-429b-9c48-4420c860e064",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "84c4573e-372a-412f-92a0-66f12cafc4ed",
"Start": "2026-10-29T18:28:05.0705037+00:00",
"Due": "2026-10-29T18:28:05.0705037+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "84c4573e-372a-412f-92a0-66f12cafc4ed",
"Start": "2026-10-29T18:28:05.0705037+00:00",
"Due": "2026-10-29T18:28:05.0705037+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "136a2d25-5508-4bf7-ad52-e96bbe75d7f9",
"WorkTypeParentId": "6e483c77-f758-49dd-b479-e663e0bddef8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a0bab7cd-62f5-4360-b6ac-4ce55a10eb1c",
"UPN": "6e396419-3da2-4033-b843-ed27aace406b",
"PostDate": "2026-10-29T18:28:05.0705037+00:00",
"Comment": "sample string 4",
"CC": [
"540cfec0-5cae-469f-b5f6-4c4d44d545ff",
"5d3f7e7d-0e71-4673-8fde-3e50b5ae769a"
],
"Users": [
"05dc7ce1-28ab-477b-a6fa-a99350430b84",
"fc56828a-c6e0-43d1-8f22-4f0dfb40ef46"
]
},
{
"Id": "a0bab7cd-62f5-4360-b6ac-4ce55a10eb1c",
"UPN": "6e396419-3da2-4033-b843-ed27aace406b",
"PostDate": "2026-10-29T18:28:05.0705037+00:00",
"Comment": "sample string 4",
"CC": [
"540cfec0-5cae-469f-b5f6-4c4d44d545ff",
"5d3f7e7d-0e71-4673-8fde-3e50b5ae769a"
],
"Users": [
"05dc7ce1-28ab-477b-a6fa-a99350430b84",
"fc56828a-c6e0-43d1-8f22-4f0dfb40ef46"
]
}
],
"StartDate": "2026-10-29T18:28:05.0705037+00:00",
"DueDate": "2026-10-29T18:28:05.0705037+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"900b0394-29d4-406c-9109-cddf0b6da245": "9a6b83b3-7379-49cb-8a4a-9ded44950606",
"f2a63588-4fe0-4857-a286-eac056460de0": "a8c67dc6-fdab-4708-8ac4-e9e672a8225f"
},
"HasUpdates": true,
"Modified": "2026-10-29T18:28:05.0705037+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-10-29T18:28:05.0705037+00:00"
},
"LastComment": "2026-10-29T18:28:05.0705037+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2e02178d-d985-472b-be74-0653b97c6e25",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "95f8df5e-29b7-49e7-8422-a5fde31ef890",
"id": "0140b845-f07f-4348-b931-161abccd1623",
"ConfigId": "c6163b91-370e-4c54-a10c-2acf3dc6e29a"
}