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": "835894b5-9e1d-49e2-a66b-c7e8c345f7ba",
"ParentTaskId": "2668507d-afef-48cb-9dcc-7471a664634d",
"Integration": {
"IntegrationId": "e8afca14-172c-4940-91cf-371a77d9c2aa",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e3897fdb-8084-4eea-bbb4-4f6a6e6a28e8": 2.0,
"8ad2934c-dfda-44f8-b2c1-13df572605ce": 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": "ef908ccf-240d-4987-8100-4e3e80ca604a",
"Name": "sample string 1",
"Created": "2026-06-25T17:39:10.9477587+00:00",
"Modified": "2026-06-25T17:39:10.9477587+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d350549c-9a61-45a8-82d3-2ecf821e4b51",
"1b202317-daba-4650-8260-722ac402dc58"
],
"NonLaborAssignments": [
{
"Id": "fd1b812e-ea3a-4946-a695-41d9cfa0d07b",
"ResourceId": "17973bac-6315-4850-9afb-8550c8bcb30b",
"Quantity": 3.0
},
{
"Id": "fd1b812e-ea3a-4946-a695-41d9cfa0d07b",
"ResourceId": "17973bac-6315-4850-9afb-8550c8bcb30b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ac8d3e6b-00a2-4d02-824c-9e3ca4c4f59b",
"Type": 0,
"ResourceId": "199e4c88-86b9-41d2-827b-49d4d2098efc",
"Units": 3.0
},
{
"Id": "ac8d3e6b-00a2-4d02-824c-9e3ca4c4f59b",
"Type": 0,
"ResourceId": "199e4c88-86b9-41d2-827b-49d4d2098efc",
"Units": 3.0
}
],
"ParentId": "f0de1c99-e32a-45a5-bee9-840a713aa5c4",
"WorkTypeParentId": "f6c90207-b783-43ab-8f07-4172d5018825",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b82bc809-4f4b-4c38-b8bd-294b00a170e2",
"UPN": "8c364a7a-625c-44ba-8288-a96cad6e6137",
"PostDate": "2026-06-25T17:39:10.9477587+00:00",
"Comment": "sample string 4",
"CC": [
"3d642769-4cdc-4cd1-9d1d-36da8ec70766",
"9f21d9f0-d5e3-45ff-93d7-9104b4a7376b"
],
"Users": [
"b2e5059f-cd1d-4f5e-8473-cdde10bba735",
"089221ad-3317-4582-83ea-df736b0be69c"
]
},
{
"Id": "b82bc809-4f4b-4c38-b8bd-294b00a170e2",
"UPN": "8c364a7a-625c-44ba-8288-a96cad6e6137",
"PostDate": "2026-06-25T17:39:10.9477587+00:00",
"Comment": "sample string 4",
"CC": [
"3d642769-4cdc-4cd1-9d1d-36da8ec70766",
"9f21d9f0-d5e3-45ff-93d7-9104b4a7376b"
],
"Users": [
"b2e5059f-cd1d-4f5e-8473-cdde10bba735",
"089221ad-3317-4582-83ea-df736b0be69c"
]
}
],
"StartDate": "2026-06-25T17:39:10.9477587+00:00",
"DueDate": "2026-06-25T17:39:10.9477587+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9b0e557c-cc2c-4ea7-9bc8-af00f02bfa0d": "7d57ea12-fe4c-4940-abc7-4ed3044c7721",
"2797dd8e-7435-461b-9fd6-cc09a9aabcbe": "381ce82f-4598-43be-8266-1977cbafda95"
},
"HasUpdates": true,
"Modified": "2026-06-25T17:39:10.9477587+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-25T17:39:10.9477587+00:00"
},
"LastComment": "2026-06-25T17:39:10.9477587+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "89d0f7af-6f2b-43fe-8a9f-caf100a7abf9",
"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": "053577d8-4978-484e-a7f0-91e553a35cc4",
"id": "7d0e2662-940f-4558-95fe-cfed67fcc336",
"ConfigId": "4262d7db-3a80-4486-961f-5043a92076bf"
}