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": "fe6a25a4-8f22-41c3-91aa-88a27022710f",
"ParentTaskId": "a0908c37-7dbd-405e-a969-cf28be12258e",
"Integration": {
"IntegrationId": "fd352934-f2b9-48db-8cc9-2942d461a0db",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0b6ab0b4-06aa-46f3-823b-d6314512732e": 2.0,
"4c9343a4-47d5-4be4-8238-b386d383735f": 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": "c0169cde-b252-4b74-8114-266fad9d5fd0",
"Name": "sample string 1",
"Created": "2026-08-14T07:49:08.1277409+00:00",
"Modified": "2026-08-14T07:49:08.1277409+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e76ba109-9c87-4ab1-ad73-ba63737e2eac",
"ebf3e533-3d1a-474b-9a6e-aecaa0876606"
],
"NonLaborAssignments": [
{
"Id": "e3853642-c1fe-4972-b532-fc1e64384bd3",
"ResourceId": "6cc66c0c-b3ce-47f6-bc44-0b72923a8045",
"Quantity": 3.0
},
{
"Id": "e3853642-c1fe-4972-b532-fc1e64384bd3",
"ResourceId": "6cc66c0c-b3ce-47f6-bc44-0b72923a8045",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "772625ad-ddfb-4ae7-89e3-a0d57913c4e7",
"Type": 0,
"ResourceId": "cedee2d3-70a9-494b-8b1e-249aaa3be403",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "772625ad-ddfb-4ae7-89e3-a0d57913c4e7",
"Type": 0,
"ResourceId": "cedee2d3-70a9-494b-8b1e-249aaa3be403",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "0dceecef-c4f5-407b-922c-0db210d409d4",
"WorkTypeParentId": "2cc4f419-57c2-4699-8c76-52b628f1881d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b37f01e1-4de7-4a9c-9ea2-ca717d426d4d",
"UPN": "740ceb6f-aee0-47d5-9d39-610b6a9f9537",
"PostDate": "2026-08-14T07:49:08.1277409+00:00",
"Comment": "sample string 4",
"CC": [
"a42790dc-a75c-4434-a605-5b6e6dc2c72a",
"e7c4e0f3-c0e1-44b1-b52f-aaf619b46e59"
],
"Users": [
"bb55a6ba-3a6b-4cf7-9ddc-36dbb713e434",
"5bb81cbe-dd03-4bb5-8a87-5cedacb4e896"
]
},
{
"Id": "b37f01e1-4de7-4a9c-9ea2-ca717d426d4d",
"UPN": "740ceb6f-aee0-47d5-9d39-610b6a9f9537",
"PostDate": "2026-08-14T07:49:08.1277409+00:00",
"Comment": "sample string 4",
"CC": [
"a42790dc-a75c-4434-a605-5b6e6dc2c72a",
"e7c4e0f3-c0e1-44b1-b52f-aaf619b46e59"
],
"Users": [
"bb55a6ba-3a6b-4cf7-9ddc-36dbb713e434",
"5bb81cbe-dd03-4bb5-8a87-5cedacb4e896"
]
}
],
"StartDate": "2026-08-14T07:49:08.1277409+00:00",
"DueDate": "2026-08-14T07:49:08.1277409+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d8f8c569-8b4b-4ab4-b10c-e58b6cee64de": "312c1d9e-743a-4832-bcfc-1f7409258ff2",
"9d00adca-04fd-43f2-bc86-36444b662433": "fd9727b4-4f94-4fd1-aef1-fb95f689f970"
},
"HasUpdates": true,
"Modified": "2026-08-14T07:49:08.1277409+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-14T07:49:08.1277409+00:00"
},
"LastComment": "2026-08-14T07:49:08.1277409+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9dfd1eca-fe7d-4506-b5a0-c905ff187425",
"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": "a481c963-7dce-444f-b541-b077fdf3e42f",
"id": "64d88798-8fbd-4da2-9b87-c62c84ebd623",
"ConfigId": "bc2b72fc-fb17-4ac8-9382-a9100ad8cd0f"
}