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": "f06c2e2f-af47-4902-adbd-96e74438fd30",
"ParentTaskId": "4656a1ca-b6e7-4688-845b-c0bf542499e1",
"Integration": {
"IntegrationId": "405eb2b7-eb0b-45f5-8415-51c20fec5b3a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a15a7206-ad9a-45c4-bd3d-a0e9fda8fd59": 2.0,
"d52a1265-065b-4de4-a7c4-adfc983c9e47": 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": "189e244a-ec40-4841-a68a-c8ecfa25b1c3",
"Name": "sample string 1",
"Created": "2026-07-27T06:56:13.2321635+00:00",
"Modified": "2026-07-27T06:56:13.2321635+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2f28f43f-d857-4a4f-b585-52c8d925bc59",
"b5ff2b93-21e1-4ce3-80a1-eb0f3df47730"
],
"NonLaborAssignments": [
{
"Id": "4a643462-df8d-4a33-a064-bd626e3fe2ba",
"ResourceId": "a2da08fe-68e4-41f9-b546-bbe66d830ef4",
"Quantity": 3.0
},
{
"Id": "4a643462-df8d-4a33-a064-bd626e3fe2ba",
"ResourceId": "a2da08fe-68e4-41f9-b546-bbe66d830ef4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "dd2bd909-f7d2-4a29-9aab-030c6671ad67",
"Type": 0,
"ResourceId": "2b185b84-011c-43fe-adff-60c04c9b4c40",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "dd2bd909-f7d2-4a29-9aab-030c6671ad67",
"Type": 0,
"ResourceId": "2b185b84-011c-43fe-adff-60c04c9b4c40",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "0c7c6707-9eef-48a4-b2d9-699b3a2baa32",
"WorkTypeParentId": "9a12cae4-e95e-4d26-ac7b-295ba776fc6e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "26ddb0e3-d7a0-4dda-982d-17b3a0bc69fd",
"UPN": "3daddecd-9907-4dfc-817b-40f1acfdf9fd",
"PostDate": "2026-07-27T06:56:13.2321635+00:00",
"Comment": "sample string 4",
"CC": [
"baa856c7-d9dc-4f9d-9bad-6d65d864d3c8",
"8da1e94e-0024-42c9-9ce8-225f141a832b"
],
"Users": [
"e31ebce0-6df5-4134-8d8c-d6a4e6200931",
"fe2c7fd2-2bc0-4d57-8642-390af3cc03fa"
]
},
{
"Id": "26ddb0e3-d7a0-4dda-982d-17b3a0bc69fd",
"UPN": "3daddecd-9907-4dfc-817b-40f1acfdf9fd",
"PostDate": "2026-07-27T06:56:13.2321635+00:00",
"Comment": "sample string 4",
"CC": [
"baa856c7-d9dc-4f9d-9bad-6d65d864d3c8",
"8da1e94e-0024-42c9-9ce8-225f141a832b"
],
"Users": [
"e31ebce0-6df5-4134-8d8c-d6a4e6200931",
"fe2c7fd2-2bc0-4d57-8642-390af3cc03fa"
]
}
],
"StartDate": "2026-07-27T06:56:13.2321635+00:00",
"DueDate": "2026-07-27T06:56:13.2321635+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"77ba279f-fedd-45f5-9bb9-e80ea93f0a9a": "3814a167-0607-452d-aadb-a79744b3876f",
"d1d2f7af-139d-4005-bbcf-1d9ee6a28a00": "973f1ff3-e3d5-4375-adf4-38c2b87f0205"
},
"HasUpdates": true,
"Modified": "2026-07-27T06:56:13.2321635+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-27T06:56:13.2321635+00:00"
},
"LastComment": "2026-07-27T06:56:13.2321635+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f1e39693-6163-430e-b684-ae96d9c527b8",
"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": "6a46f8d4-2560-49ff-93d0-2014b6fbcaa7",
"id": "bf36a341-d322-4318-9f19-2821c1e74bd5",
"ConfigId": "1d88e849-e063-4b93-b4d4-167350cf9b3b"
}