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": "2b0cff85-3aad-4466-9b96-513d1677499b",
"ParentTaskId": "16962a83-068b-4a37-a19e-bb0e41e65e94",
"Integration": {
"IntegrationId": "a91b4cdd-bac6-4ac4-985f-bd7be5aab46b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8bb93014-0118-4b28-bfd2-611fcecb0c45": 2.0,
"a0da96be-42bd-4668-a1bb-e9648e365201": 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": "2d4d3f49-ec85-455c-9e57-da82dda0eb75",
"Name": "sample string 1",
"Created": "2026-07-27T20:11:38.4491501+00:00",
"Modified": "2026-07-27T20:11:38.4491501+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ac4056cf-d09a-4995-8fff-aaf6ee1bc989",
"f6581721-5f88-417c-bfd7-16c2450b8fe3"
],
"NonLaborAssignments": [
{
"Id": "920ec5c1-85c2-42c7-80a4-a6e2382f46b8",
"ResourceId": "c7e4570c-13aa-46d8-8856-3b5011fdc35e",
"Quantity": 3.0
},
{
"Id": "920ec5c1-85c2-42c7-80a4-a6e2382f46b8",
"ResourceId": "c7e4570c-13aa-46d8-8856-3b5011fdc35e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bc46bfac-d588-4c6f-967a-5c6711190277",
"Type": 0,
"ResourceId": "48c252ec-8160-4a82-86cc-708ee884f41d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "bc46bfac-d588-4c6f-967a-5c6711190277",
"Type": 0,
"ResourceId": "48c252ec-8160-4a82-86cc-708ee884f41d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3701a6f0-340c-4488-a662-499f0ef26923",
"WorkTypeParentId": "9be0c0aa-ff83-4a39-bc02-124d9d50a869",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "682ae118-ca09-4ed9-a398-bc8e28eaab50",
"UPN": "7bb38d8d-6b98-4aab-9e07-9446958951b9",
"PostDate": "2026-07-27T20:11:38.4491501+00:00",
"Comment": "sample string 4",
"CC": [
"9501e9e4-ac7a-4bc8-8226-872502fbee89",
"18deec94-289f-44e8-a13a-52b095ea51c6"
],
"Users": [
"f234b3e6-8849-4099-b23b-9b3bef3ef4aa",
"0833b537-e377-46a3-abb0-aa8f243ce8fb"
]
},
{
"Id": "682ae118-ca09-4ed9-a398-bc8e28eaab50",
"UPN": "7bb38d8d-6b98-4aab-9e07-9446958951b9",
"PostDate": "2026-07-27T20:11:38.4491501+00:00",
"Comment": "sample string 4",
"CC": [
"9501e9e4-ac7a-4bc8-8226-872502fbee89",
"18deec94-289f-44e8-a13a-52b095ea51c6"
],
"Users": [
"f234b3e6-8849-4099-b23b-9b3bef3ef4aa",
"0833b537-e377-46a3-abb0-aa8f243ce8fb"
]
}
],
"StartDate": "2026-07-27T20:11:38.4491501+00:00",
"DueDate": "2026-07-27T20:11:38.4491501+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b095229c-3eb2-4481-a10b-7785836b7511": "88b458b5-b908-4eb9-88ac-2fe9af834245",
"5f12e029-ec53-4a2a-9622-329dff2d383f": "fc0908d9-06a5-4b85-bce4-9dfc8917bb28"
},
"HasUpdates": true,
"Modified": "2026-07-27T20:11:38.4491501+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-27T20:11:38.4491501+00:00"
},
"LastComment": "2026-07-27T20:11:38.4491501+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7319c45c-5ebf-4352-a250-9299d62241ff",
"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": "90de7ca4-0fae-4edb-bd1b-31e0ad973a46",
"id": "d8b0c7f5-078e-4eea-96ff-c9ca5e088ed6",
"ConfigId": "82fc1c66-aaed-4244-b0c0-82f6b94b1abe"
}