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": "9ca226a7-0aca-4022-948b-9df7189cf089",
"ParentTaskId": "45474ddd-54fc-4e8b-9f6b-dfe818fa5e47",
"Integration": {
"IntegrationId": "f388a173-7d26-43ed-9c46-a55b0ceee6ac",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"97fff1b4-d53a-4f74-94da-b7e22e59658e": 2.0,
"982a57bf-ba56-4406-9ef8-a53856f0b5ba": 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": "8b3bc1d8-63f0-4b38-85d1-cc9c2ee7e755",
"Name": "sample string 1",
"Created": "2026-05-09T01:23:20.7484446+00:00",
"Modified": "2026-05-09T01:23:20.7484446+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4d6da1af-8722-47a0-b842-272779cb645d",
"0db20955-9061-4d69-8682-67aa62d0368c"
],
"NonLaborAssignments": [
{
"Id": "9c80a988-36ae-4af9-bcfe-f5ddd6ee8e28",
"ResourceId": "b7d9d371-3152-4ca2-a9b2-949b8170b9c5",
"Quantity": 3.0
},
{
"Id": "9c80a988-36ae-4af9-bcfe-f5ddd6ee8e28",
"ResourceId": "b7d9d371-3152-4ca2-a9b2-949b8170b9c5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "68c4c41d-1dcf-4b45-bf6f-d8074b63c3a7",
"Type": 0,
"ResourceId": "c35d37ed-6ae3-4afc-9ae6-6e0fbeb0fde3",
"Units": 3.0
},
{
"Id": "68c4c41d-1dcf-4b45-bf6f-d8074b63c3a7",
"Type": 0,
"ResourceId": "c35d37ed-6ae3-4afc-9ae6-6e0fbeb0fde3",
"Units": 3.0
}
],
"ParentId": "0adbe5fb-84ef-4b81-865d-5dcdb609bf86",
"WorkTypeParentId": "77d5e2e1-d6ac-4415-a07a-beac527f0606",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a6a4a042-2928-47df-9f4b-a6a6fe6ea98b",
"UPN": "59440a8f-1eda-4ef3-ba5a-0ffb66427e6b",
"PostDate": "2026-05-09T01:23:20.7484446+00:00",
"Comment": "sample string 4",
"CC": [
"afeaf204-178a-493c-9a7d-3bb418190f15",
"2661d3fc-96b9-4886-a8b3-c06fd492bf56"
],
"Users": [
"d717b058-2901-415c-94a3-03a138b2e18c",
"219b7249-2a50-44a6-853c-2ebaca4fbbc6"
]
},
{
"Id": "a6a4a042-2928-47df-9f4b-a6a6fe6ea98b",
"UPN": "59440a8f-1eda-4ef3-ba5a-0ffb66427e6b",
"PostDate": "2026-05-09T01:23:20.7484446+00:00",
"Comment": "sample string 4",
"CC": [
"afeaf204-178a-493c-9a7d-3bb418190f15",
"2661d3fc-96b9-4886-a8b3-c06fd492bf56"
],
"Users": [
"d717b058-2901-415c-94a3-03a138b2e18c",
"219b7249-2a50-44a6-853c-2ebaca4fbbc6"
]
}
],
"StartDate": "2026-05-09T01:23:20.7484446+00:00",
"DueDate": "2026-05-09T01:23:20.7484446+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1c9ea137-6abc-42a9-8e11-a3238fcfbdaf": "6c40cb0c-33f8-408f-b7ef-690268591a4d",
"0568479e-9934-4246-a359-831ddd709db7": "756b40dc-61ec-4225-8c7a-d001f1f099f7"
},
"HasUpdates": true,
"Modified": "2026-05-09T01:23:20.7484446+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-09T01:23:20.7484446+00:00"
},
"LastComment": "2026-05-09T01:23:20.7484446+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "efa3f8db-7452-492d-bc06-60a4c18018dd",
"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": "9e6e67f1-b929-481b-94a8-8940eb6fff07",
"id": "21fc1a7c-7c2b-468b-9740-3dba78150d74",
"ConfigId": "7305060e-bfdd-4768-b4a5-46f59afa1f0e"
}