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": "fda5dcd6-b04d-4f1d-85a5-c07ebb8c07b9",
"ParentTaskId": "9bdcb491-0a09-4da5-ae87-779e2b16d4aa",
"Integration": {
"IntegrationId": "0c1f88b1-4497-4518-81ce-792ef2ff0bfa",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5acd565c-7311-4d5d-a3b6-c364aeab10ab": 2.0,
"705d8ec6-d2ec-460f-af9e-b697b5c39f4f": 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": "deb22aa7-0427-4913-b93f-0b3339bd9b4c",
"Name": "sample string 1",
"Created": "2026-08-14T12:19:39.1963638+00:00",
"Modified": "2026-08-14T12:19:39.1963638+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c6752d2e-67cf-4749-9b82-7f7a1c780955",
"9e6038ea-8762-496c-9a03-1d78b3e5d8e6"
],
"NonLaborAssignments": [
{
"Id": "e891813d-7803-481d-9681-e4144eb3c75e",
"ResourceId": "00146f3b-da89-42dc-8873-db662119f903",
"Quantity": 3.0
},
{
"Id": "e891813d-7803-481d-9681-e4144eb3c75e",
"ResourceId": "00146f3b-da89-42dc-8873-db662119f903",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "61f868ff-21fc-4635-ac4f-8fc8a5648107",
"Type": 0,
"ResourceId": "4409ebe9-974f-4b05-8dfd-d0fb69f9605e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "61f868ff-21fc-4635-ac4f-8fc8a5648107",
"Type": 0,
"ResourceId": "4409ebe9-974f-4b05-8dfd-d0fb69f9605e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "e1e8936f-fd9e-4cc4-b2a3-5ecb5210dc11",
"WorkTypeParentId": "23d3b8a0-f782-4744-9091-03a991cebf40",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7496ed49-ea02-4c73-aa30-b7cce81fac66",
"UPN": "35697b69-87c9-4003-ac5a-3b4f9cfbbd61",
"PostDate": "2026-08-14T12:19:39.1963638+00:00",
"Comment": "sample string 4",
"CC": [
"f0d5b3e4-460f-42d4-8cf4-0c28a52456a8",
"8d1ea6ff-5125-41d7-b281-6d4aadc16d15"
],
"Users": [
"d49fabca-e785-4b52-b1fd-059d007927b1",
"edd3d72e-bacd-404b-bc9c-a8ef959bee7d"
]
},
{
"Id": "7496ed49-ea02-4c73-aa30-b7cce81fac66",
"UPN": "35697b69-87c9-4003-ac5a-3b4f9cfbbd61",
"PostDate": "2026-08-14T12:19:39.1963638+00:00",
"Comment": "sample string 4",
"CC": [
"f0d5b3e4-460f-42d4-8cf4-0c28a52456a8",
"8d1ea6ff-5125-41d7-b281-6d4aadc16d15"
],
"Users": [
"d49fabca-e785-4b52-b1fd-059d007927b1",
"edd3d72e-bacd-404b-bc9c-a8ef959bee7d"
]
}
],
"StartDate": "2026-08-14T12:19:39.1963638+00:00",
"DueDate": "2026-08-14T12:19:39.1963638+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3a3de427-91b8-463a-a8db-85e57c41fdbc": "7cfc268d-1216-4698-a508-a36f29977810",
"80f0f38a-9dc3-40f8-98df-ca6ed58988e8": "5da3786a-7f63-4e2e-88ba-773aad80bd1a"
},
"HasUpdates": true,
"Modified": "2026-08-14T12:19:39.1963638+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-08-14T12:19:39.1963638+00:00"
},
"LastComment": "2026-08-14T12:19:39.1963638+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d2852789-9402-4994-88e6-3e1696e8d3a7",
"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": "d4863032-7a23-4bbf-bb11-06ee72e689b1",
"id": "9ae996e5-f2f7-4867-8f11-e75eee376477",
"ConfigId": "a013083d-92cd-4051-ad8f-63dd8d890de0"
}