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": "04b462d3-a4bd-4ca3-899e-c6f6d17f4438",
"ParentTaskId": "e0f9f690-8b9d-48f2-a135-277740507d6d",
"Integration": {
"IntegrationId": "14359df1-cf64-45de-a491-1916f50f9b77",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e49a73e7-c33e-4cd0-b465-631330bf4695": 2.0,
"f7cb6371-288e-43d0-bdfa-d242bc95aa7b": 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": "64ee2771-9e2d-48d0-9e1f-e9a729cdfec8",
"Name": "sample string 1",
"Created": "2026-04-18T06:30:17.5899243+00:00",
"Modified": "2026-04-18T06:30:17.5899243+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2927b9cd-5a87-49a7-acf7-1f1ffa0a0453",
"c150c57a-a5af-474a-82f2-b2d6cd57bc4d"
],
"NonLaborAssignments": [
{
"Id": "5253ea48-5b1d-454c-bb11-f91c6342470d",
"ResourceId": "95b0ed76-9cf0-41d3-98c5-49f8ca5755e6",
"Quantity": 3.0
},
{
"Id": "5253ea48-5b1d-454c-bb11-f91c6342470d",
"ResourceId": "95b0ed76-9cf0-41d3-98c5-49f8ca5755e6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "25e4d0d0-fded-4a52-aa2e-00fd68cc0786",
"Type": 0,
"ResourceId": "a815d8a7-3c98-4c02-92b8-a7a6c40b2c0b",
"Units": 3.0
},
{
"Id": "25e4d0d0-fded-4a52-aa2e-00fd68cc0786",
"Type": 0,
"ResourceId": "a815d8a7-3c98-4c02-92b8-a7a6c40b2c0b",
"Units": 3.0
}
],
"ParentId": "a177eb0b-92f3-4550-a2a8-a3d2e6fbadc4",
"WorkTypeParentId": "6f3e9b5f-0abc-49c7-b613-902f8b07d0d9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "063d778c-a244-467f-a705-c01677f137b1",
"UPN": "21e10de8-134a-4f6f-a5d6-3082b9702795",
"PostDate": "2026-04-18T06:30:17.6055507+00:00",
"Comment": "sample string 4",
"CC": [
"7eef2f5c-4cc6-4ee8-928c-042de026f881",
"1a285459-ed3a-4280-8dc2-ee6b1bc9a153"
],
"Users": [
"fa45ce5c-bc05-427a-80db-2d200d9f1760",
"48d9431b-7a6e-4696-8ce0-cd462d25f08c"
]
},
{
"Id": "063d778c-a244-467f-a705-c01677f137b1",
"UPN": "21e10de8-134a-4f6f-a5d6-3082b9702795",
"PostDate": "2026-04-18T06:30:17.6055507+00:00",
"Comment": "sample string 4",
"CC": [
"7eef2f5c-4cc6-4ee8-928c-042de026f881",
"1a285459-ed3a-4280-8dc2-ee6b1bc9a153"
],
"Users": [
"fa45ce5c-bc05-427a-80db-2d200d9f1760",
"48d9431b-7a6e-4696-8ce0-cd462d25f08c"
]
}
],
"StartDate": "2026-04-18T06:30:17.6055507+00:00",
"DueDate": "2026-04-18T06:30:17.6055507+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ee905c6c-91ab-4c8f-a09e-73e01cc5c040": "04ecbacf-8e88-43ae-b666-d1a0703005a8",
"a67350e8-c3ff-4490-9a77-1f2dd7934daf": "4ab5db21-baa5-4946-8e19-2769ea2cbcab"
},
"HasUpdates": true,
"Modified": "2026-04-18T06:30:17.6055507+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-18T06:30:17.6055507+00:00"
},
"LastComment": "2026-04-18T06:30:17.6055507+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2e052c88-4b29-404f-bd36-48fa4db257e5",
"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": "b9c6bb2e-908e-4871-b633-17b45ec18b42",
"id": "f04277f1-f85e-4009-ab34-5868e2fbba6f",
"ConfigId": "eea79f62-9bf8-4a10-bc43-9efe63a77fcc"
}