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": "66a2c25e-f826-432e-8a8b-4664c0c8ef49",
"ParentTaskId": "73ddbd8b-dd62-4265-aaca-a77e73bf963f",
"Integration": {
"IntegrationId": "8b9cf2bf-5e75-44ff-8527-2e4370cf7bdf",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c57d375a-e1f0-46c5-80d8-855dbe437dea": 2.0,
"5fe2555d-798c-46d9-a200-9791d9cc5ba8": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "ec4f300c-0abc-469f-aba2-edb2e9bfc639",
"Name": "sample string 1",
"Created": "2025-12-21T23:29:50.1027552+00:00",
"Modified": "2025-12-21T23:29:50.1027552+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0f7b6fa1-6ff4-4b46-a60a-3ab731826c5c",
"7a4ce139-a5ab-4855-bf29-0ab8532bd21e"
],
"NonLaborAssignments": [
{
"Id": "11ef2cb8-e747-480e-86aa-84bf1aa8942d",
"ResourceId": "86bebca4-e186-4f42-b381-b4cdcda63195",
"Quantity": 3.0
},
{
"Id": "11ef2cb8-e747-480e-86aa-84bf1aa8942d",
"ResourceId": "86bebca4-e186-4f42-b381-b4cdcda63195",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "0951bdcd-7e18-4913-bc42-7dcd481120ba",
"Type": 0,
"ResourceId": "58497f43-b88b-4c28-8c8e-bc6c55c018e7",
"Units": 3.0
},
{
"Id": "0951bdcd-7e18-4913-bc42-7dcd481120ba",
"Type": 0,
"ResourceId": "58497f43-b88b-4c28-8c8e-bc6c55c018e7",
"Units": 3.0
}
],
"ParentId": "4723f7a3-734c-4ca0-9d56-2a92195ed569",
"WorkTypeParentId": "864db64a-49c5-4d31-a4c0-94cbc5ec4941",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "646e6157-7ade-422a-beae-43d59be78b5c",
"UPN": "59875875-4a30-442a-ad41-2179a0c074d6",
"PostDate": "2025-12-21T23:29:50.1027552+00:00",
"Comment": "sample string 4",
"CC": [
"8d78d5c7-c781-46b3-b547-9192aa0d2fcc",
"eeff0af8-1bc8-4ff2-a903-c7bfd18cadf4"
],
"Users": [
"455e536d-49ba-455d-87ce-d1d39b51582d",
"58801a0d-786a-4ea0-99b4-3cc55b52727f"
]
},
{
"Id": "646e6157-7ade-422a-beae-43d59be78b5c",
"UPN": "59875875-4a30-442a-ad41-2179a0c074d6",
"PostDate": "2025-12-21T23:29:50.1027552+00:00",
"Comment": "sample string 4",
"CC": [
"8d78d5c7-c781-46b3-b547-9192aa0d2fcc",
"eeff0af8-1bc8-4ff2-a903-c7bfd18cadf4"
],
"Users": [
"455e536d-49ba-455d-87ce-d1d39b51582d",
"58801a0d-786a-4ea0-99b4-3cc55b52727f"
]
}
],
"StartDate": "2025-12-21T23:29:50.1027552+00:00",
"DueDate": "2025-12-21T23:29:50.1027552+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b8dd3e5f-b366-4ed1-b4a4-44d90d4722fb": "eab05b6a-8516-4cfd-944c-80ddf22f3b20",
"209011df-6bb2-4f1a-b994-2b7b6149ab43": "1982d56f-82be-4f52-bbef-7784c69c94b3"
},
"HasUpdates": true,
"Modified": "2025-12-21T23:29:50.1027552+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": "2025-12-21T23:29:50.1027552+00:00"
},
"LastComment": "2025-12-21T23:29:50.1027552+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c982044c-a8bd-4d2a-8c31-5154e20f04ac",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "cb86f337-1864-485f-87a7-7a3c2f2088eb",
"id": "eb6dd813-332b-4d0d-850c-3370574a920f",
"ConfigId": "b3f45a8a-bf8b-45e6-ab64-9d7c2510cb30"
}