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": "fd0d50ae-d94d-45b6-b207-138b50caa23f",
"ParentTaskId": "c846ce11-b0b9-46e8-b376-194b897be44f",
"Integration": {
"IntegrationId": "23c8ed5b-2ebd-485f-99ab-4a6901621dae",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"43d26a75-4326-447f-a1af-f80820a20485": 2.0,
"f4df6afe-f774-47ae-922f-cf1698c8e7a2": 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": "33800ddc-5ee7-4d4b-84f0-591053f0fc33",
"Name": "sample string 1",
"Created": "2026-05-28T22:53:43.0957263+00:00",
"Modified": "2026-05-28T22:53:43.0957263+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"94776c0d-8271-4552-9776-14a2a9530b3d",
"961cc8e5-9127-494e-af56-e9654e905dfb"
],
"NonLaborAssignments": [
{
"Id": "ab12758b-cdcc-480f-a985-c1145d3d0d2c",
"ResourceId": "03ba8d2b-6ce3-4ed5-be1e-e13e8d73ea2c",
"Quantity": 3.0
},
{
"Id": "ab12758b-cdcc-480f-a985-c1145d3d0d2c",
"ResourceId": "03ba8d2b-6ce3-4ed5-be1e-e13e8d73ea2c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "76bbc6d8-8061-4f8b-b829-9c142e6dfda8",
"Type": 0,
"ResourceId": "7b185db6-c171-4011-b13a-04977ad6d0d7",
"Units": 3.0
},
{
"Id": "76bbc6d8-8061-4f8b-b829-9c142e6dfda8",
"Type": 0,
"ResourceId": "7b185db6-c171-4011-b13a-04977ad6d0d7",
"Units": 3.0
}
],
"ParentId": "fdbd13d0-b599-41ff-8d99-edb73218cd28",
"WorkTypeParentId": "b0d02768-8c83-43d3-aa95-51c417019343",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2f40d541-0b73-4380-a899-a64b61177091",
"UPN": "51929084-62d8-461e-a55b-41b2c291358c",
"PostDate": "2026-05-28T22:53:43.0957263+00:00",
"Comment": "sample string 4",
"CC": [
"dffce095-3f6c-4b13-a775-8603a9abfa97",
"11c893c8-bab2-4884-b5d6-db496c37d01b"
],
"Users": [
"5dc4fb56-02db-461e-90c9-f0aa79bd864d",
"9609dba0-d283-4327-b614-93e2219633a0"
]
},
{
"Id": "2f40d541-0b73-4380-a899-a64b61177091",
"UPN": "51929084-62d8-461e-a55b-41b2c291358c",
"PostDate": "2026-05-28T22:53:43.0957263+00:00",
"Comment": "sample string 4",
"CC": [
"dffce095-3f6c-4b13-a775-8603a9abfa97",
"11c893c8-bab2-4884-b5d6-db496c37d01b"
],
"Users": [
"5dc4fb56-02db-461e-90c9-f0aa79bd864d",
"9609dba0-d283-4327-b614-93e2219633a0"
]
}
],
"StartDate": "2026-05-28T22:53:43.0957263+00:00",
"DueDate": "2026-05-28T22:53:43.0957263+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"edb77121-93ff-42ec-8f93-5a8257e7fab6": "0bc9495e-7af3-4489-898b-94779d2026d8",
"421888c1-4be8-4423-926a-17a10c26f51b": "4d7026a2-4d86-48ec-a838-b7470585526d"
},
"HasUpdates": true,
"Modified": "2026-05-28T22:53:43.0957263+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-28T22:53:43.0957263+00:00"
},
"LastComment": "2026-05-28T22:53:43.0957263+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "37da18a5-0dd7-4ee0-b041-4d0a5928e642",
"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": "2917ba17-997d-4606-81c3-0a55c631f8e1",
"id": "660af84c-50b9-46f8-9f8c-831ff547d576",
"ConfigId": "f07079f5-85fa-4f55-a210-ffb49486f59f"
}