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": "87fa17ae-d412-4986-8ae2-2d8c99b638db",
"ParentTaskId": "e8d7067f-371e-4821-8a0b-8419148ef914",
"Integration": {
"IntegrationId": "7d7ff538-3af1-4280-8c03-0f54386b41ae",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"941b60ef-10d2-42f8-8532-caffa4160d8a": 2.0,
"015298a1-9383-4ba5-8d71-d5905384c35f": 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": "a16b803f-e459-41b6-b394-8a8112753a43",
"Name": "sample string 1",
"Created": "2026-06-20T04:46:00.4219112+00:00",
"Modified": "2026-06-20T04:46:00.4219112+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"dfa9d3cd-18ab-4806-9df2-96b1113cffae",
"e25f0201-a5c0-4862-a412-2b8cc0b04f2c"
],
"NonLaborAssignments": [
{
"Id": "0b7277d6-f537-47e3-9f0e-e4ea2a579abd",
"ResourceId": "ede70039-3477-4479-87f9-36108e04e7d3",
"Quantity": 3.0
},
{
"Id": "0b7277d6-f537-47e3-9f0e-e4ea2a579abd",
"ResourceId": "ede70039-3477-4479-87f9-36108e04e7d3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "49ab5d18-3a69-4b8a-9498-2873c72ec15b",
"Type": 0,
"ResourceId": "8252ac11-a654-4e86-8d7c-fbbd66b2696f",
"Units": 3.0
},
{
"Id": "49ab5d18-3a69-4b8a-9498-2873c72ec15b",
"Type": 0,
"ResourceId": "8252ac11-a654-4e86-8d7c-fbbd66b2696f",
"Units": 3.0
}
],
"ParentId": "70b51c8a-1498-4050-a190-f5070f540f3f",
"WorkTypeParentId": "cdf7bb95-9bc9-434c-b0d8-4d319417ad79",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "96b76ae9-d2e0-4bd0-84b7-438390471c22",
"UPN": "43c43441-5007-4495-a120-3113702d38c1",
"PostDate": "2026-06-20T04:46:00.4219112+00:00",
"Comment": "sample string 4",
"CC": [
"82f440e5-62e6-4e9d-b6da-fec2a0bd3142",
"73600caa-ebac-4b82-8e48-ee40493f1a58"
],
"Users": [
"8cecd5e6-1f8c-4a58-8511-eee2a59042ac",
"c12a7b35-5cef-4fac-86f3-6cc6a59a4ae5"
]
},
{
"Id": "96b76ae9-d2e0-4bd0-84b7-438390471c22",
"UPN": "43c43441-5007-4495-a120-3113702d38c1",
"PostDate": "2026-06-20T04:46:00.4219112+00:00",
"Comment": "sample string 4",
"CC": [
"82f440e5-62e6-4e9d-b6da-fec2a0bd3142",
"73600caa-ebac-4b82-8e48-ee40493f1a58"
],
"Users": [
"8cecd5e6-1f8c-4a58-8511-eee2a59042ac",
"c12a7b35-5cef-4fac-86f3-6cc6a59a4ae5"
]
}
],
"StartDate": "2026-06-20T04:46:00.4219112+00:00",
"DueDate": "2026-06-20T04:46:00.4219112+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4614e09b-0170-44bb-b616-f8c9bbf64e80": "db62791b-246a-4369-b562-8b4b69221b65",
"0cebfaa3-5cc3-44f4-917c-8d8070f46b8a": "ceebb45c-abd8-4f16-9a71-3f3c7b4c183a"
},
"HasUpdates": true,
"Modified": "2026-06-20T04:46:00.4219112+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-06-20T04:46:00.4219112+00:00"
},
"LastComment": "2026-06-20T04:46:00.4219112+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "922a5e5b-22b2-4e9b-bb7e-7f908fab1c4e",
"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": "2c87fec9-10e1-4be6-b1ea-2f069a05c715",
"id": "ca3e0a1f-10fe-4479-a502-37620c1e79fd",
"ConfigId": "c8538c6c-7a67-49d3-9d2e-fbd8b2b8dd06"
}