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": "5f149155-8700-4671-956a-1c2d6564a465",
"ParentTaskId": "77f89afe-e96b-4064-9060-be0c79e31876",
"Integration": {
"IntegrationId": "13cd29dc-0357-4c51-afb9-95feb6166bb1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"da09f525-6b09-452b-ab6a-f2fabf2c87bb": 2.0,
"30462fe9-eed3-4824-a0c4-3e1ba78def0a": 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": "30064c0a-5b59-4e32-8072-a7696b3a4a95",
"Name": "sample string 1",
"Created": "2026-05-07T07:09:47.941223+00:00",
"Modified": "2026-05-07T07:09:47.941223+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2ed44f94-240a-471c-aae3-f605a2a7b4c7",
"8f9acbf3-1417-404f-9f08-775cbe791458"
],
"NonLaborAssignments": [
{
"Id": "3a46011f-750c-4d98-a2f4-42231c49fc0f",
"ResourceId": "351164aa-7f77-47fa-8bf8-db7dba52aff3",
"Quantity": 3.0
},
{
"Id": "3a46011f-750c-4d98-a2f4-42231c49fc0f",
"ResourceId": "351164aa-7f77-47fa-8bf8-db7dba52aff3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c9f1a09f-ac8a-4b32-be34-10652bfd2517",
"Type": 0,
"ResourceId": "377a9718-8bb4-43e6-9ea9-b1d6ca05aeca",
"Units": 3.0
},
{
"Id": "c9f1a09f-ac8a-4b32-be34-10652bfd2517",
"Type": 0,
"ResourceId": "377a9718-8bb4-43e6-9ea9-b1d6ca05aeca",
"Units": 3.0
}
],
"ParentId": "c9bbf739-1d67-4eb1-94cc-d1ce338d6dad",
"WorkTypeParentId": "a8543815-ef47-499e-a7bb-4f6a0d4aad1a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7cc76af7-0402-4d80-a180-311647da4e4f",
"UPN": "fb9a5d9c-c4a3-468d-866e-37cd2dc731b6",
"PostDate": "2026-05-07T07:09:47.941223+00:00",
"Comment": "sample string 4",
"CC": [
"29e50877-d32d-43f6-9ccd-add88ad70f58",
"254094e1-ebce-44ba-8b32-753d512fd1d3"
],
"Users": [
"4ef42d38-b6bf-4a70-825f-6faf6f5eba34",
"e88c462c-422e-49a6-b156-77903c9f2062"
]
},
{
"Id": "7cc76af7-0402-4d80-a180-311647da4e4f",
"UPN": "fb9a5d9c-c4a3-468d-866e-37cd2dc731b6",
"PostDate": "2026-05-07T07:09:47.941223+00:00",
"Comment": "sample string 4",
"CC": [
"29e50877-d32d-43f6-9ccd-add88ad70f58",
"254094e1-ebce-44ba-8b32-753d512fd1d3"
],
"Users": [
"4ef42d38-b6bf-4a70-825f-6faf6f5eba34",
"e88c462c-422e-49a6-b156-77903c9f2062"
]
}
],
"StartDate": "2026-05-07T07:09:47.941223+00:00",
"DueDate": "2026-05-07T07:09:47.941223+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1a863ccc-8b07-43bb-8014-6b057415cb82": "7651f1fd-6c98-421c-a222-4a293b0e822d",
"38eaa1e0-0e08-4ca7-bd31-390a54dbe5a8": "d16b3ef4-96e6-4def-8a2b-b784c2c8eaa8"
},
"HasUpdates": true,
"Modified": "2026-05-07T07:09:47.941223+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-05-07T07:09:47.941223+00:00"
},
"LastComment": "2026-05-07T07:09:47.941223+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "16e78d9e-33fe-4262-990a-f00d87abdf35",
"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": "237a9c22-e8bd-4853-b619-684b77f6b883",
"id": "c7efbccb-beff-40b9-b4c9-10ad65fda0bf",
"ConfigId": "cfda59cd-ebd4-457b-84cb-f4f7cd07ec9c"
}