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": "b7933c2e-b75e-41bf-8d25-3ee765490fac",
"ParentTaskId": "30ca79f0-7f1c-4fb2-a5c7-f2b4188a149a",
"Integration": {
"IntegrationId": "01f31f12-d73e-4fea-bef5-5c0e8a164286",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b7383a69-4db8-4624-817a-cd14ce751287": 2.0,
"2cbe4249-633c-4fc9-ab18-ab4ab5b418c9": 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": "6a6fe63c-a0b8-447a-9576-8828fb9acfd9",
"Name": "sample string 1",
"Created": "2026-08-26T09:09:27.1286835+00:00",
"Modified": "2026-08-26T09:09:27.1286835+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9653e478-c09c-4308-936d-e740a5cd403c",
"ff0a7715-a75b-4556-8943-fbc83edcdb60"
],
"NonLaborAssignments": [
{
"Id": "c2f0d8bb-180c-4825-8941-bf4719cb3893",
"ResourceId": "409387e4-c912-45ad-8274-d2f359fff947",
"Quantity": 3.0
},
{
"Id": "c2f0d8bb-180c-4825-8941-bf4719cb3893",
"ResourceId": "409387e4-c912-45ad-8274-d2f359fff947",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "32a541c0-f469-4bf9-8007-947a250d9bc6",
"Type": 0,
"ResourceId": "453a8230-2475-4e8f-a120-002c4ad11cbc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "32a541c0-f469-4bf9-8007-947a250d9bc6",
"Type": 0,
"ResourceId": "453a8230-2475-4e8f-a120-002c4ad11cbc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "0fd97b3a-984f-44d9-bb0d-29fc0dbf89fa",
"WorkTypeParentId": "f1bf021f-3d3b-4f4c-b640-cb8d37d70c94",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ece5a2e4-0ab4-4eb5-b1e7-c740556198de",
"UPN": "4f4f0a8e-97d8-4df0-8690-9eac41eb27e8",
"PostDate": "2026-08-26T09:09:27.1286835+00:00",
"Comment": "sample string 4",
"CC": [
"2ad5b2c6-d010-412b-a507-9c18c663d329",
"ec1ecbfa-5b29-4255-adca-176391320e4c"
],
"Users": [
"1a1054cc-7fbe-4a82-8b38-16192d9ede95",
"e6e5ec15-6510-46d2-80e7-2172e6ee92d0"
]
},
{
"Id": "ece5a2e4-0ab4-4eb5-b1e7-c740556198de",
"UPN": "4f4f0a8e-97d8-4df0-8690-9eac41eb27e8",
"PostDate": "2026-08-26T09:09:27.1286835+00:00",
"Comment": "sample string 4",
"CC": [
"2ad5b2c6-d010-412b-a507-9c18c663d329",
"ec1ecbfa-5b29-4255-adca-176391320e4c"
],
"Users": [
"1a1054cc-7fbe-4a82-8b38-16192d9ede95",
"e6e5ec15-6510-46d2-80e7-2172e6ee92d0"
]
}
],
"StartDate": "2026-08-26T09:09:27.1286835+00:00",
"DueDate": "2026-08-26T09:09:27.1286835+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ba72c58e-8381-4ca9-989c-3c78e545d2de": "1f10d31b-43ab-4bca-b45e-fd5ccb53c2b4",
"47fbf2f5-e2ed-4e94-ba63-a68039f196a9": "ae342078-c4fc-457d-88ce-a905da9df2ce"
},
"HasUpdates": true,
"Modified": "2026-08-26T09:09:27.1442962+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-26T09:09:27.1442962+00:00"
},
"LastComment": "2026-08-26T09:09:27.1442962+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "597e6238-573a-4bd1-8c33-c94c7291434a",
"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": "7bbee04f-0d9c-46fc-9521-f38aee008f53",
"id": "9eb99d0d-305b-4004-afc9-008740b9ba3c",
"ConfigId": "ada8bf2f-fbfc-4263-adc8-f1f028d3bb12"
}