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": "ed49c200-f1d0-4e23-b0ca-4dfe871de8a8",
"ParentTaskId": "885306c2-5ed2-4b9c-bc7c-dd3f82b689fb",
"Integration": {
"IntegrationId": "ac04afe7-f8f5-4caf-ad16-d42c0a9800b8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6b94a4ee-73ff-40c3-bbd5-854000539cd7": 2.0,
"48c4f0a1-825c-4fd3-bfbe-2c4bb8598749": 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": "a7b77d44-886f-4cc7-ab96-b1138fe002fa",
"Name": "sample string 1",
"Created": "2026-04-29T19:15:15.5105998+00:00",
"Modified": "2026-04-29T19:15:15.5105998+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"566eddcf-22c2-4c28-98ce-0a741b195003",
"e5e7958e-0b9d-4133-bdde-c01081a9ebce"
],
"NonLaborAssignments": [
{
"Id": "85068fa1-aad8-4107-a0ce-272f9a3b6ca4",
"ResourceId": "49d46bf1-524e-44a5-9c99-57a58fcec70e",
"Quantity": 3.0
},
{
"Id": "85068fa1-aad8-4107-a0ce-272f9a3b6ca4",
"ResourceId": "49d46bf1-524e-44a5-9c99-57a58fcec70e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bf19f5ea-bff0-4f2a-aa07-52a7c5d0e2c8",
"Type": 0,
"ResourceId": "a0316f9c-36ef-4c1e-ad99-a79ad0be176e",
"Units": 3.0
},
{
"Id": "bf19f5ea-bff0-4f2a-aa07-52a7c5d0e2c8",
"Type": 0,
"ResourceId": "a0316f9c-36ef-4c1e-ad99-a79ad0be176e",
"Units": 3.0
}
],
"ParentId": "fe8b78a2-4a64-4af4-85fa-6c35360335f0",
"WorkTypeParentId": "cb78945f-ae61-4fe5-b651-a14221187c94",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "79fabc2b-ac38-45c7-9f4a-5512774ec20a",
"UPN": "5c93d995-b29f-4cee-a4d3-a6b74b0b5c7c",
"PostDate": "2026-04-29T19:15:15.5105998+00:00",
"Comment": "sample string 4",
"CC": [
"a21f4cbf-b62b-443e-bdba-0cb0bcc7d47b",
"e7e0c35c-0cc2-4b2c-a793-570dae8e3461"
],
"Users": [
"e26b2418-ba04-4988-ba05-e5d20940ed0a",
"355cd199-37fe-4378-af6a-5e4ae0741c64"
]
},
{
"Id": "79fabc2b-ac38-45c7-9f4a-5512774ec20a",
"UPN": "5c93d995-b29f-4cee-a4d3-a6b74b0b5c7c",
"PostDate": "2026-04-29T19:15:15.5105998+00:00",
"Comment": "sample string 4",
"CC": [
"a21f4cbf-b62b-443e-bdba-0cb0bcc7d47b",
"e7e0c35c-0cc2-4b2c-a793-570dae8e3461"
],
"Users": [
"e26b2418-ba04-4988-ba05-e5d20940ed0a",
"355cd199-37fe-4378-af6a-5e4ae0741c64"
]
}
],
"StartDate": "2026-04-29T19:15:15.5105998+00:00",
"DueDate": "2026-04-29T19:15:15.5105998+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fb4ac205-37ef-40fa-a945-321bd7ccb38b": "35324bbe-c0ab-448e-8f52-2a3a37c83e22",
"390214f2-072f-4916-b1ac-518c376dba14": "0723cecc-63de-41f3-96e2-32e267be55b2"
},
"HasUpdates": true,
"Modified": "2026-04-29T19:15:15.5105998+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-04-29T19:15:15.5105998+00:00"
},
"LastComment": "2026-04-29T19:15:15.5105998+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2b7217d2-dab5-40dd-b491-17b72c7b83ac",
"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": "183d8ca9-c4dc-4a53-80c8-20aca996eb1e",
"id": "407990a5-3bfd-4c67-98b3-603088d1323b",
"ConfigId": "95d20165-11af-4e5d-ae39-0c1220ecf95d"
}