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": "70c9d467-9afa-4ad1-937e-711fb4105c61",
"ParentTaskId": "011d89db-c132-42fa-bd4f-934c5f57e944",
"Integration": {
"IntegrationId": "1865d558-2838-427a-a28a-5b9f146f604c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a74cfd70-96cb-4c19-9640-8c78066a0ea0": 2.0,
"644d7f19-ce40-44ca-a0db-d1b055283cb9": 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": "e0b375b1-5728-4fdc-8bd9-b2c0e7d680cc",
"Name": "sample string 1",
"Created": "2026-05-29T17:57:12.3048576+00:00",
"Modified": "2026-05-29T17:57:12.3048576+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5e1f4156-2c90-48cc-9395-e1da7cdaacf9",
"6c0fa64b-4848-41f5-b26a-a3102f651d26"
],
"NonLaborAssignments": [
{
"Id": "4b413c48-555c-47c5-a828-2dd1a30509fa",
"ResourceId": "339b0cc8-ffae-421f-b85d-948fc5f437e8",
"Quantity": 3.0
},
{
"Id": "4b413c48-555c-47c5-a828-2dd1a30509fa",
"ResourceId": "339b0cc8-ffae-421f-b85d-948fc5f437e8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "14fc6242-e0c7-4bd4-8b79-7565ce05eab4",
"Type": 0,
"ResourceId": "890577bf-33d1-4551-87c3-01373c88b0f3",
"Units": 3.0
},
{
"Id": "14fc6242-e0c7-4bd4-8b79-7565ce05eab4",
"Type": 0,
"ResourceId": "890577bf-33d1-4551-87c3-01373c88b0f3",
"Units": 3.0
}
],
"ParentId": "c9b7d4ae-6b40-44a1-987a-c3b7b5c625bb",
"WorkTypeParentId": "bdaf7b2e-31b1-4254-bd59-e55e9cbda7b8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "59e75a80-9028-4c66-bc34-612bdb020333",
"UPN": "1f27d3d5-75b0-46a4-b858-2dd79c5ef77a",
"PostDate": "2026-05-29T17:57:12.3048576+00:00",
"Comment": "sample string 4",
"CC": [
"45874453-e0cf-4792-ada7-cab3590ad634",
"ebe0b853-e33e-4733-8e59-74183122dc1f"
],
"Users": [
"a3903fa1-7a1e-4ac4-ba10-98cc8e6c1466",
"a2184dc7-3927-45b2-a966-28afba352eb3"
]
},
{
"Id": "59e75a80-9028-4c66-bc34-612bdb020333",
"UPN": "1f27d3d5-75b0-46a4-b858-2dd79c5ef77a",
"PostDate": "2026-05-29T17:57:12.3048576+00:00",
"Comment": "sample string 4",
"CC": [
"45874453-e0cf-4792-ada7-cab3590ad634",
"ebe0b853-e33e-4733-8e59-74183122dc1f"
],
"Users": [
"a3903fa1-7a1e-4ac4-ba10-98cc8e6c1466",
"a2184dc7-3927-45b2-a966-28afba352eb3"
]
}
],
"StartDate": "2026-05-29T17:57:12.3048576+00:00",
"DueDate": "2026-05-29T17:57:12.3048576+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"63694fe4-8e88-44b0-8991-0990bfe1992f": "f545d930-d344-42fa-94a0-41a9ac972910",
"9b2e373a-b0dc-48c6-8faf-ee06b6897475": "f1d53c65-8d22-457b-bc42-1fd1dc2e38a5"
},
"HasUpdates": true,
"Modified": "2026-05-29T17:57:12.3048576+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-29T17:57:12.3048576+00:00"
},
"LastComment": "2026-05-29T17:57:12.3048576+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e7479223-d758-4171-95cd-29b2b6f0a87a",
"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": "c35eff65-f612-4b4f-8d05-757cbe00b861",
"id": "f74471d3-c7e9-476c-90b3-b55ede21db95",
"ConfigId": "0c688e37-cd78-4984-aeeb-82bd08f36d3b"
}