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": "7a42dda9-844a-4702-aac1-3a55718fc053",
"ParentTaskId": "8ec7104d-8f90-4093-ac86-be720fc4e846",
"Integration": {
"IntegrationId": "2ea5dad5-1f40-462a-b1d2-aa015c9beeab",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"84439240-90ea-4771-b2b2-7c158feb9983": 2.0,
"e0de6c47-1dd5-404d-b7be-2f5f7e9ffec2": 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": "ca5f3c05-f5b0-4a11-bc96-2c682838af02",
"Name": "sample string 1",
"Created": "2026-05-10T03:18:20.2200264+00:00",
"Modified": "2026-05-10T03:18:20.2200264+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ed316dbc-d68a-43c1-ad95-b98921b84f55",
"172ec269-b7f0-446b-a47e-85b5dd17a618"
],
"NonLaborAssignments": [
{
"Id": "8c61c732-e44d-43ac-9069-938cf6327d8f",
"ResourceId": "3878b3cf-7c5b-4020-b765-25f0e4e9b17a",
"Quantity": 3.0
},
{
"Id": "8c61c732-e44d-43ac-9069-938cf6327d8f",
"ResourceId": "3878b3cf-7c5b-4020-b765-25f0e4e9b17a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1933d92c-d0d0-48d9-8c65-86f03e934543",
"Type": 0,
"ResourceId": "9fb5060a-19f0-4f3f-987a-aad739ea4e18",
"Units": 3.0
},
{
"Id": "1933d92c-d0d0-48d9-8c65-86f03e934543",
"Type": 0,
"ResourceId": "9fb5060a-19f0-4f3f-987a-aad739ea4e18",
"Units": 3.0
}
],
"ParentId": "98a89b2e-27f6-4541-b9dc-5941bd6a014d",
"WorkTypeParentId": "05e6ee36-00ef-40a4-9cad-3cccca391866",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e4333d11-3944-40e6-895b-98e71c6fe737",
"UPN": "a18aed93-15d5-4e7f-9c88-c6d8b1781743",
"PostDate": "2026-05-10T03:18:20.2200264+00:00",
"Comment": "sample string 4",
"CC": [
"9906523a-8c69-4381-ab98-ede541b76573",
"aec6faf4-c825-417d-9bbd-ed75b33c2ba5"
],
"Users": [
"585d7e31-3c1f-45dc-a2ec-a7cc236e20d7",
"cd8cb522-b53e-4485-b3ca-b5f2cb4d124d"
]
},
{
"Id": "e4333d11-3944-40e6-895b-98e71c6fe737",
"UPN": "a18aed93-15d5-4e7f-9c88-c6d8b1781743",
"PostDate": "2026-05-10T03:18:20.2200264+00:00",
"Comment": "sample string 4",
"CC": [
"9906523a-8c69-4381-ab98-ede541b76573",
"aec6faf4-c825-417d-9bbd-ed75b33c2ba5"
],
"Users": [
"585d7e31-3c1f-45dc-a2ec-a7cc236e20d7",
"cd8cb522-b53e-4485-b3ca-b5f2cb4d124d"
]
}
],
"StartDate": "2026-05-10T03:18:20.2200264+00:00",
"DueDate": "2026-05-10T03:18:20.2200264+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d0409a94-8dba-441c-be33-5c1bef070683": "e2fc209d-0ca8-4566-add2-f81d7bb64ffc",
"1bfc64ad-a51b-4349-b5c5-3a371786a60e": "13da7fe7-018c-436f-ade4-d296213c8b65"
},
"HasUpdates": true,
"Modified": "2026-05-10T03:18:20.2200264+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-05-10T03:18:20.2200264+00:00"
},
"LastComment": "2026-05-10T03:18:20.2200264+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9ac4eb20-eaf3-4ac1-99ab-b74d2d258e68",
"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": "5cab6cbc-82a1-48a3-82e3-a0027bc0b49a",
"id": "d251d65c-8105-4b40-9d2b-aa4241b8e600",
"ConfigId": "6889558f-b7b0-45de-bc83-5e06c4cfb88d"
}