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": "4890c77b-463a-41db-9189-75c6dc2938ec",
"ParentTaskId": "e391c76e-d43a-4037-aa61-a76238cafaa9",
"Integration": {
"IntegrationId": "71397d13-0937-4f67-a3f8-9f8f0d6635cc",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5aace58e-fa47-408a-ba09-6d4834b6b929": 2.0,
"7dbdaa90-2066-445e-931d-60069c315617": 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": "d808cc77-3060-48ce-bf53-9d98e2d432d3",
"Name": "sample string 1",
"Created": "2026-07-02T00:06:23.7313694+00:00",
"Modified": "2026-07-02T00:06:23.7313694+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f98d6f33-4b7d-4fa2-858f-9e01badffb08",
"6d303774-19a7-46c3-8764-a1c6614c3b64"
],
"NonLaborAssignments": [
{
"Id": "75be8fa3-c884-4e27-b84c-5cabd72bd7e6",
"ResourceId": "400f4b03-cd82-41c7-b8df-c2f8a50066e5",
"Quantity": 3.0
},
{
"Id": "75be8fa3-c884-4e27-b84c-5cabd72bd7e6",
"ResourceId": "400f4b03-cd82-41c7-b8df-c2f8a50066e5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "99680e96-1779-4161-87a9-43d8a26338da",
"Type": 0,
"ResourceId": "998948b1-4023-421f-b8df-d58a0e0789c2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "99680e96-1779-4161-87a9-43d8a26338da",
"Type": 0,
"ResourceId": "998948b1-4023-421f-b8df-d58a0e0789c2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "edcea19e-39e9-4eea-ab66-a38a3086190d",
"WorkTypeParentId": "222524c0-5cd8-4ff5-a3c7-3cdf308482af",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3f092c9d-932d-4d16-b063-cd11ddf20bea",
"UPN": "8aa4ff2c-1b34-417a-a39d-84cd59c248c5",
"PostDate": "2026-07-02T00:06:23.7313694+00:00",
"Comment": "sample string 4",
"CC": [
"41e39e5e-4c5b-4067-a6df-a2074c65883f",
"1fce13ec-3c47-4be0-8dd1-834227f07645"
],
"Users": [
"66c3eb2b-86d5-4716-b126-40a606ea09fb",
"d2917bad-0f26-407f-8000-ba0c4eb710ce"
]
},
{
"Id": "3f092c9d-932d-4d16-b063-cd11ddf20bea",
"UPN": "8aa4ff2c-1b34-417a-a39d-84cd59c248c5",
"PostDate": "2026-07-02T00:06:23.7313694+00:00",
"Comment": "sample string 4",
"CC": [
"41e39e5e-4c5b-4067-a6df-a2074c65883f",
"1fce13ec-3c47-4be0-8dd1-834227f07645"
],
"Users": [
"66c3eb2b-86d5-4716-b126-40a606ea09fb",
"d2917bad-0f26-407f-8000-ba0c4eb710ce"
]
}
],
"StartDate": "2026-07-02T00:06:23.7313694+00:00",
"DueDate": "2026-07-02T00:06:23.7313694+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fbb4c937-ccfc-4462-aa76-9d381b0ae360": "e6c1120b-a931-4f36-a2c6-8a98dc3743d0",
"f936c00a-b125-43e8-a566-32bf4ddf3039": "f25438e0-2bb7-451b-97ce-c818b0afffa8"
},
"HasUpdates": true,
"Modified": "2026-07-02T00:06:23.7313694+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-02T00:06:23.7313694+00:00"
},
"LastComment": "2026-07-02T00:06:23.7313694+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d447d9a0-4d56-4812-bbdb-905cb29d961e",
"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": "c69b3788-b80f-452c-8e88-d0cc14dab56c",
"id": "2dbb502e-df1d-494e-9d43-e49faeda6655",
"ConfigId": "add27c07-c5f2-46a7-8b13-09e83f7b6442"
}