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": "1213c227-b782-43c4-bc6a-7fe640dd1f17",
"ParentTaskId": "e643a49f-3eaa-449d-b0b9-f6e99225049b",
"Integration": {
"IntegrationId": "4417a9b5-1d5a-439d-a906-4ce05da55074",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fba1d1da-eec1-4e34-a821-32667cb72f47": 2.0,
"f69053c3-141e-43b5-97fa-7d650b1eed41": 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": "a168576b-6c7d-421b-8f4d-af8f2035fd39",
"Name": "sample string 1",
"Created": "2026-05-27T03:37:41.2321529+00:00",
"Modified": "2026-05-27T03:37:41.2321529+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d3d43c9f-c5a4-4924-81e2-e11a07e323ac",
"522200ee-5f7c-468a-a65a-3a9233c9b3fd"
],
"NonLaborAssignments": [
{
"Id": "e3cdaf87-111f-4ee1-84ab-42615f599e72",
"ResourceId": "1a41961e-c519-4b0d-be87-2f933abb559c",
"Quantity": 3.0
},
{
"Id": "e3cdaf87-111f-4ee1-84ab-42615f599e72",
"ResourceId": "1a41961e-c519-4b0d-be87-2f933abb559c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "cb22ecb8-c553-40fc-86a6-2514fc094a2b",
"Type": 0,
"ResourceId": "6b53bc40-5b90-487c-9142-d216489ef646",
"Units": 3.0
},
{
"Id": "cb22ecb8-c553-40fc-86a6-2514fc094a2b",
"Type": 0,
"ResourceId": "6b53bc40-5b90-487c-9142-d216489ef646",
"Units": 3.0
}
],
"ParentId": "6c53fb7e-0630-4fe9-a7f3-2c51198caa96",
"WorkTypeParentId": "e3cb707b-08d2-4141-8d00-6fa903d448cc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d9fe5069-114b-4818-a686-ee5b7100ec66",
"UPN": "dd46a0ad-7d82-4003-b9fd-5ad81e92126f",
"PostDate": "2026-05-27T03:37:41.2321529+00:00",
"Comment": "sample string 4",
"CC": [
"3feb817d-fe83-48e8-9a17-2d8326cb22d7",
"3d93fbca-ce30-4567-bafa-f7c51ef1234e"
],
"Users": [
"a1b78a8c-ee11-4d7e-9b2d-a6efd479fd51",
"1276d437-61e2-419d-a512-deb9a5ef108e"
]
},
{
"Id": "d9fe5069-114b-4818-a686-ee5b7100ec66",
"UPN": "dd46a0ad-7d82-4003-b9fd-5ad81e92126f",
"PostDate": "2026-05-27T03:37:41.2321529+00:00",
"Comment": "sample string 4",
"CC": [
"3feb817d-fe83-48e8-9a17-2d8326cb22d7",
"3d93fbca-ce30-4567-bafa-f7c51ef1234e"
],
"Users": [
"a1b78a8c-ee11-4d7e-9b2d-a6efd479fd51",
"1276d437-61e2-419d-a512-deb9a5ef108e"
]
}
],
"StartDate": "2026-05-27T03:37:41.2321529+00:00",
"DueDate": "2026-05-27T03:37:41.2321529+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"eae81a53-b2d4-4fdd-8904-ebb3297a104b": "2db075b8-aa76-4431-9680-9a7796a6798a",
"2f51b422-123b-4e79-8a78-d176ed5b7de7": "8b643c10-5ffb-42ac-acf3-56932a28d0db"
},
"HasUpdates": true,
"Modified": "2026-05-27T03:37:41.2321529+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-27T03:37:41.2321529+00:00"
},
"LastComment": "2026-05-27T03:37:41.2321529+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "508f64c4-5708-4af5-8a1d-129e77d6b0c3",
"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": "7fd41711-46c9-4230-9a25-928dcb5e0a08",
"id": "9eef36f2-e56b-46e8-ab9b-9cafe3d66225",
"ConfigId": "18124f8f-6281-4939-b5c4-8ffb9f7e1c09"
}