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": "d9403d95-3bd5-4c8d-b9fc-9e354f8cba2e",
"ParentTaskId": "1e2b65f1-8745-46bd-9d60-1b943ec7ba06",
"Integration": {
"IntegrationId": "0a6ae132-df13-4fc9-9ca7-701afb53439d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"875b50e6-50cd-41e6-b77d-ecd554898b00": 2.0,
"664dfe34-c4e5-45ff-bcbe-5ae7d5000a41": 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": "6e2c8ad9-4c5e-4745-bd54-5943bd7e3e05",
"Name": "sample string 1",
"Created": "2026-07-22T19:20:45.2446026+00:00",
"Modified": "2026-07-22T19:20:45.2446026+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5d0853cf-7c3f-4f7d-b7a7-f85ddbce4729",
"0f4a7341-30ed-40f7-8ad7-4b43fb87b03e"
],
"NonLaborAssignments": [
{
"Id": "5db5c389-aafe-468c-bdc7-04a1bea8ee3b",
"ResourceId": "e5a13bd3-7b94-4e9d-9eb0-ec5f73bb5134",
"Quantity": 3.0
},
{
"Id": "5db5c389-aafe-468c-bdc7-04a1bea8ee3b",
"ResourceId": "e5a13bd3-7b94-4e9d-9eb0-ec5f73bb5134",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b78f2768-acd2-4e4a-9369-f1b12492876e",
"Type": 0,
"ResourceId": "aa33ada9-a4b5-4304-9f7a-7dd5bfdfd385",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "b78f2768-acd2-4e4a-9369-f1b12492876e",
"Type": 0,
"ResourceId": "aa33ada9-a4b5-4304-9f7a-7dd5bfdfd385",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "72f11d41-fa9e-429f-832e-f024721603fd",
"WorkTypeParentId": "7b7ef4aa-6293-492a-ae54-2674dfc1fd5a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a66854ce-23c6-496e-8700-d847abe3eb7c",
"UPN": "b01e6f3f-1859-4be7-b12a-2c6e72de3bba",
"PostDate": "2026-07-22T19:20:45.2446026+00:00",
"Comment": "sample string 4",
"CC": [
"2bf25e2c-97c6-4733-a766-430a81220ef4",
"010986e6-4158-4854-9b09-647225a7d8d7"
],
"Users": [
"8186934b-55db-4e46-8a42-5336f7d00525",
"4c84ac1f-a960-484e-8357-4c0b7e35b599"
]
},
{
"Id": "a66854ce-23c6-496e-8700-d847abe3eb7c",
"UPN": "b01e6f3f-1859-4be7-b12a-2c6e72de3bba",
"PostDate": "2026-07-22T19:20:45.2446026+00:00",
"Comment": "sample string 4",
"CC": [
"2bf25e2c-97c6-4733-a766-430a81220ef4",
"010986e6-4158-4854-9b09-647225a7d8d7"
],
"Users": [
"8186934b-55db-4e46-8a42-5336f7d00525",
"4c84ac1f-a960-484e-8357-4c0b7e35b599"
]
}
],
"StartDate": "2026-07-22T19:20:45.2446026+00:00",
"DueDate": "2026-07-22T19:20:45.2446026+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0763620a-8a31-483f-b182-335ae080d6fa": "8ce44ee7-04a7-4de0-9045-735a82283858",
"d965e0e2-558e-4aa0-8e3e-2626c7091d14": "2d0725be-d01d-4c5d-a009-07ab79cf0dc1"
},
"HasUpdates": true,
"Modified": "2026-07-22T19:20:45.2446026+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-22T19:20:45.2446026+00:00"
},
"LastComment": "2026-07-22T19:20:45.2446026+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6c3acac1-575a-4718-87d8-154d4e81bd60",
"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": "46bb66c0-a2bb-4826-bda6-73c8bc44a87a",
"id": "6ec48e84-dbb0-4e29-8768-728216fb230b",
"ConfigId": "b66df8c5-a112-4922-a911-4acc85252dec"
}