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": "525f74b2-0796-424d-9921-3b3efc8994bc",
"ParentTaskId": "eaccd4b7-e7c8-4423-80c9-20225bf5725b",
"Integration": {
"IntegrationId": "d7daa164-2b47-4516-af24-5bf098bd9f3e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"afdf7c0d-39dd-4371-8951-eddc00ab060c": 2.0,
"8b58cc7c-2dae-42b4-891a-4f0e90dfccf3": 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": "d2d7ae74-065d-4dfc-aaca-7c984a5dda81",
"Name": "sample string 1",
"Created": "2026-06-24T10:03:42.3809007+00:00",
"Modified": "2026-06-24T10:03:42.3809007+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9fe18c9d-34fa-4f92-86a3-ef0a3b087bb8",
"69c1d745-57d6-44ec-b072-b94c7bce4083"
],
"NonLaborAssignments": [
{
"Id": "1fd79f17-b411-4d04-bddf-36975fdb3133",
"ResourceId": "7f8fd039-e1c2-4ea9-b53f-288d1b5f1068",
"Quantity": 3.0
},
{
"Id": "1fd79f17-b411-4d04-bddf-36975fdb3133",
"ResourceId": "7f8fd039-e1c2-4ea9-b53f-288d1b5f1068",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "07c3e76a-c39b-45db-afa1-16bd01802197",
"Type": 0,
"ResourceId": "86c61f52-3970-4b4b-a490-91e848d6602f",
"Units": 3.0
},
{
"Id": "07c3e76a-c39b-45db-afa1-16bd01802197",
"Type": 0,
"ResourceId": "86c61f52-3970-4b4b-a490-91e848d6602f",
"Units": 3.0
}
],
"ParentId": "f6445d1f-75a3-42e3-8751-a02bac91c45e",
"WorkTypeParentId": "242126bc-fea2-48c1-bee6-dfd40a2782f9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c56ad656-e919-4585-addc-39cbd0d4394a",
"UPN": "b9e983df-6fed-4911-aed3-0a843eaa42cb",
"PostDate": "2026-06-24T10:03:42.3809007+00:00",
"Comment": "sample string 4",
"CC": [
"1280f1d4-655c-4467-b69c-06f0cb3d8e43",
"5fce6da8-36e6-44a1-b269-348f3074caf9"
],
"Users": [
"045554f8-97f9-42d5-9b24-8350f53a1f85",
"cdc0ce33-77e4-4967-9f5f-4cc31ffcb157"
]
},
{
"Id": "c56ad656-e919-4585-addc-39cbd0d4394a",
"UPN": "b9e983df-6fed-4911-aed3-0a843eaa42cb",
"PostDate": "2026-06-24T10:03:42.3809007+00:00",
"Comment": "sample string 4",
"CC": [
"1280f1d4-655c-4467-b69c-06f0cb3d8e43",
"5fce6da8-36e6-44a1-b269-348f3074caf9"
],
"Users": [
"045554f8-97f9-42d5-9b24-8350f53a1f85",
"cdc0ce33-77e4-4967-9f5f-4cc31ffcb157"
]
}
],
"StartDate": "2026-06-24T10:03:42.3809007+00:00",
"DueDate": "2026-06-24T10:03:42.3809007+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1dfc2d2a-e290-4fef-9a40-dfa74cc879ee": "a06c613e-447e-48b2-9198-7ede2023b0e2",
"4fc97a96-6722-4ce4-aa8c-5a87be0bfd69": "6e4cb847-b3f4-4fda-89f8-848060927fe2"
},
"HasUpdates": true,
"Modified": "2026-06-24T10:03:42.3809007+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-06-24T10:03:42.3809007+00:00"
},
"LastComment": "2026-06-24T10:03:42.3809007+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e73bc7e7-4e4b-4168-95b5-6a39886ebcc3",
"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": "c964ca56-0016-4413-b38f-1150f84ec9e8",
"id": "eed65445-2036-4b6d-92b1-afc63da1e1f3",
"ConfigId": "ad2989a6-7e55-4b2d-9ab7-6ed2f9628d27"
}