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": "5e5f9c57-b7c5-4798-b498-e11e6687a698",
"ParentTaskId": "fcaf1f55-29de-4131-ad44-121bbddfd5df",
"Integration": {
"IntegrationId": "9658525c-7db6-4767-91b5-be8919db138e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e7badd55-fa5b-47db-94aa-228c69c0a559": 2.0,
"245af81c-9d22-43d4-b396-038404ba03aa": 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": "fd6352da-845c-4416-9de7-d705c8b8d89f",
"Name": "sample string 1",
"Created": "2026-07-17T16:38:34.8738036+00:00",
"Modified": "2026-07-17T16:38:34.8738036+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bbddc144-f287-43af-b87c-b30cbc33a27a",
"7483d0ff-520e-4c57-8255-e37b288b8c72"
],
"NonLaborAssignments": [
{
"Id": "36a1015f-4098-45a7-bb4c-dea7c0e85de8",
"ResourceId": "30988353-1eba-43f0-9a09-e70fb87face9",
"Quantity": 3.0
},
{
"Id": "36a1015f-4098-45a7-bb4c-dea7c0e85de8",
"ResourceId": "30988353-1eba-43f0-9a09-e70fb87face9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1d465acf-afe4-4a70-a6d7-1119a6dec8e8",
"Type": 0,
"ResourceId": "7f437b5a-20c9-495b-a797-3f17ccdf2dbd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "1d465acf-afe4-4a70-a6d7-1119a6dec8e8",
"Type": 0,
"ResourceId": "7f437b5a-20c9-495b-a797-3f17ccdf2dbd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "310b2eb3-8a25-41eb-a7d8-c2a6285cc1fe",
"WorkTypeParentId": "07cdfeac-3e42-4418-960e-bc9917ea24bb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "aee8d32f-1857-4016-8a09-a33b517e5530",
"UPN": "edde97bb-d019-42ef-9d3b-835704730a34",
"PostDate": "2026-07-17T16:38:34.8738036+00:00",
"Comment": "sample string 4",
"CC": [
"ad823118-b305-4463-885e-f75b24e1465c",
"ea20807d-a3e7-44a7-a40b-caad4f382899"
],
"Users": [
"e1198afa-0f43-4943-aa9f-39a6514567b8",
"5687c2fe-e6ed-4e2b-882a-50d75ea2cb1c"
]
},
{
"Id": "aee8d32f-1857-4016-8a09-a33b517e5530",
"UPN": "edde97bb-d019-42ef-9d3b-835704730a34",
"PostDate": "2026-07-17T16:38:34.8738036+00:00",
"Comment": "sample string 4",
"CC": [
"ad823118-b305-4463-885e-f75b24e1465c",
"ea20807d-a3e7-44a7-a40b-caad4f382899"
],
"Users": [
"e1198afa-0f43-4943-aa9f-39a6514567b8",
"5687c2fe-e6ed-4e2b-882a-50d75ea2cb1c"
]
}
],
"StartDate": "2026-07-17T16:38:34.8738036+00:00",
"DueDate": "2026-07-17T16:38:34.8738036+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"48638a03-ab9a-4628-92f7-11f8a6fff4bf": "0a7d2501-418b-4853-be52-ca00b80788f7",
"e532f586-9f72-493d-bc85-d91dcba76b6e": "f16877e0-7a74-4a5d-833a-d89e2600ae23"
},
"HasUpdates": true,
"Modified": "2026-07-17T16:38:34.8738036+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-17T16:38:34.8738036+00:00"
},
"LastComment": "2026-07-17T16:38:34.8738036+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7e331b07-ff25-46c4-a708-0c9b128c9dd0",
"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": "1bae4e1a-cb4a-41e9-a307-edfcab3015a1",
"id": "a2f3dbd1-b005-4e45-aaae-f356515a34e6",
"ConfigId": "411f7bc0-a87e-41e6-93ad-2c1c2446c0b2"
}