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": "c7acaa80-10ad-4dff-9f26-f0ff26166dfa",
"ParentTaskId": "3dcee622-94c5-430b-b525-0ca022b748f3",
"Integration": {
"IntegrationId": "7547e9e3-7e54-4f47-aaf9-44a045df3109",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d336372f-f0e1-4315-818f-7823d527ed74": 2.0,
"b6ee58bd-a2e6-4408-bdf0-55a740def557": 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": "5cf0cc33-d004-406c-b406-5fa3f800f7a2",
"Name": "sample string 1",
"Created": "2026-07-14T15:28:46.4621138+00:00",
"Modified": "2026-07-14T15:28:46.4621138+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d62888da-0787-480c-9c07-b3e8ef7103d9",
"e0a44693-9fa9-4137-8577-3710a5a0a36e"
],
"NonLaborAssignments": [
{
"Id": "74584f7e-9f79-49d3-ad5c-1331cf4e4227",
"ResourceId": "13fe1270-e92c-4a12-afd1-1aa9d6bf95ed",
"Quantity": 3.0
},
{
"Id": "74584f7e-9f79-49d3-ad5c-1331cf4e4227",
"ResourceId": "13fe1270-e92c-4a12-afd1-1aa9d6bf95ed",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "54911dc7-120c-41c1-be68-ac14b879f1e7",
"Type": 0,
"ResourceId": "49fa4ba4-aa65-4b9c-a5b0-af1e410d4eb3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "54911dc7-120c-41c1-be68-ac14b879f1e7",
"Type": 0,
"ResourceId": "49fa4ba4-aa65-4b9c-a5b0-af1e410d4eb3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "660050f0-ce22-4682-b552-519b8d869671",
"WorkTypeParentId": "6f4b2d1e-6bdd-4f82-8723-52cf380788fa",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "fd7d5815-5bb8-4721-ba67-75e43e587232",
"UPN": "712965cc-6f32-44d7-bfe2-e6f045805b25",
"PostDate": "2026-07-14T15:28:46.4621138+00:00",
"Comment": "sample string 4",
"CC": [
"d77e7fae-fd48-492c-98bf-e29a9f54aa5a",
"fdbca236-deff-4680-bf88-9bff1a86a687"
],
"Users": [
"bfbdb4d6-d786-48c5-aeea-6e5a1f7161da",
"27530c3a-7359-4f82-bd9d-696b7ee78eb7"
]
},
{
"Id": "fd7d5815-5bb8-4721-ba67-75e43e587232",
"UPN": "712965cc-6f32-44d7-bfe2-e6f045805b25",
"PostDate": "2026-07-14T15:28:46.4621138+00:00",
"Comment": "sample string 4",
"CC": [
"d77e7fae-fd48-492c-98bf-e29a9f54aa5a",
"fdbca236-deff-4680-bf88-9bff1a86a687"
],
"Users": [
"bfbdb4d6-d786-48c5-aeea-6e5a1f7161da",
"27530c3a-7359-4f82-bd9d-696b7ee78eb7"
]
}
],
"StartDate": "2026-07-14T15:28:46.4621138+00:00",
"DueDate": "2026-07-14T15:28:46.4621138+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2972b626-fa34-4408-b157-55895b3cb1e7": "98e33f21-7792-4def-b4c2-71f22d65a7a1",
"0de0fa98-585d-4fcc-8788-3b0f364c5f86": "6e3236d1-ac0b-4689-a2d0-1008d7fb618a"
},
"HasUpdates": true,
"Modified": "2026-07-14T15:28:46.4621138+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-07-14T15:28:46.4621138+00:00"
},
"LastComment": "2026-07-14T15:28:46.4621138+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cdc90d6d-12bc-4ab0-b24e-00cc9e951dfc",
"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": "9a026aa4-c0c9-4ae5-9d7e-77439c122900",
"id": "a21724f8-52e2-46b1-926d-8bf5fabdad62",
"ConfigId": "b050f649-0a32-4f87-9208-ed31e6acf48b"
}