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": "28c87c95-c2e5-4d5a-90ec-6b053d2dd8a1",
"ParentTaskId": "2e13f34b-6b47-4c67-a93c-ab9981b9231d",
"Integration": {
"IntegrationId": "a9ade647-e4ee-4f2f-b268-cb06367e0380",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3403ae0f-e4ae-412e-9c3b-4788ae0ddd78": 2.0,
"da5daf11-fe19-4606-b11f-8b467390a6ca": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "567ebcec-b72e-4828-8411-dbed098330a2",
"Name": "sample string 1",
"Created": "2026-02-06T13:51:24.4027606+00:00",
"Modified": "2026-02-06T13:51:24.4027606+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7e3d1fc8-7fa0-42c6-b6cf-26e4c8149d7d",
"2d4faad7-885d-4255-9e81-57f709073fe7"
],
"NonLaborAssignments": [
{
"Id": "83a35eea-e997-4625-a1af-1f1e8ad0e071",
"ResourceId": "54e745c9-94be-4cba-a8a8-065372615336",
"Quantity": 3.0
},
{
"Id": "83a35eea-e997-4625-a1af-1f1e8ad0e071",
"ResourceId": "54e745c9-94be-4cba-a8a8-065372615336",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8226bc8e-3e27-4a85-ac5a-c94cbee2a43e",
"Type": 0,
"ResourceId": "bd0ad18f-f644-416a-b20f-40fedd3a2eef",
"Units": 3.0
},
{
"Id": "8226bc8e-3e27-4a85-ac5a-c94cbee2a43e",
"Type": 0,
"ResourceId": "bd0ad18f-f644-416a-b20f-40fedd3a2eef",
"Units": 3.0
}
],
"ParentId": "64f43dfa-ab90-4b0f-926e-4551e440ad23",
"WorkTypeParentId": "960697b2-4ae8-4945-8804-12e7c3b19020",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "613bdea1-a045-4fce-969f-98b2ddcf610e",
"UPN": "a4d1146e-f656-41e2-bf2c-859bdfc0d87c",
"PostDate": "2026-02-06T13:51:24.4027606+00:00",
"Comment": "sample string 4",
"CC": [
"dd3d386c-32c2-47c0-8eca-e5782d9ec6b3",
"67b5964f-3e34-4541-959e-dde845dcd886"
],
"Users": [
"9a462039-3ca2-4868-a032-ae425a139173",
"3c63b11f-3f86-4f15-ab62-fead3661ba03"
]
},
{
"Id": "613bdea1-a045-4fce-969f-98b2ddcf610e",
"UPN": "a4d1146e-f656-41e2-bf2c-859bdfc0d87c",
"PostDate": "2026-02-06T13:51:24.4027606+00:00",
"Comment": "sample string 4",
"CC": [
"dd3d386c-32c2-47c0-8eca-e5782d9ec6b3",
"67b5964f-3e34-4541-959e-dde845dcd886"
],
"Users": [
"9a462039-3ca2-4868-a032-ae425a139173",
"3c63b11f-3f86-4f15-ab62-fead3661ba03"
]
}
],
"StartDate": "2026-02-06T13:51:24.4027606+00:00",
"DueDate": "2026-02-06T13:51:24.4027606+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"66c33711-4a97-4170-8525-e93dda685d3d": "12b5ffb1-f5ab-458c-9000-2e47ef3cc288",
"a3817598-19a1-4a63-b225-ddc8735daed7": "35b4987d-ebf5-421f-b524-b6a9100fb7cc"
},
"HasUpdates": true,
"Modified": "2026-02-06T13:51:24.4027606+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-02-06T13:51:24.4027606+00:00"
},
"LastComment": "2026-02-06T13:51:24.4027606+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "188944fb-0993-43f2-b74d-c9864516d685",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "b977fee4-f7b7-4a99-b856-32bf6fc89779",
"id": "0f55fadc-ca35-4778-9c0e-43bd25a3a844",
"ConfigId": "7e6973d9-00e8-49af-9157-f1c65005be58"
}