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": "7af31211-8d0f-44cd-a4ad-74d98ffcee05",
"ParentTaskId": "c7c8e839-7f0b-40e9-9cd4-cb7427f8cfe7",
"Integration": {
"IntegrationId": "d1eda358-5a79-4feb-99e3-78770d19e8ff",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6b857da5-4722-4aa0-a3b7-b963923f3425": 2.0,
"c7bb41b5-95d7-4329-bded-4ef81b8c15e3": 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": "e33ebab5-5476-449c-8655-663f81c55bcd",
"Name": "sample string 1",
"Created": "2026-07-22T06:59:59.2358789+00:00",
"Modified": "2026-07-22T06:59:59.2358789+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"09101cd1-1d05-4665-b1a8-6676e63183dd",
"09f125d2-5a53-4877-93d5-fc78fe668dfa"
],
"NonLaborAssignments": [
{
"Id": "a88f8d7a-f996-4770-b188-e9834e76169b",
"ResourceId": "4427dc28-9cf0-4538-b62d-c51983339639",
"Quantity": 3.0
},
{
"Id": "a88f8d7a-f996-4770-b188-e9834e76169b",
"ResourceId": "4427dc28-9cf0-4538-b62d-c51983339639",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5a67ce58-98dc-4c28-8814-b18308afc1a4",
"Type": 0,
"ResourceId": "bac813d0-3ada-4b69-850b-736b1b00d985",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "5a67ce58-98dc-4c28-8814-b18308afc1a4",
"Type": 0,
"ResourceId": "bac813d0-3ada-4b69-850b-736b1b00d985",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9bd3ef07-138b-40a1-80b2-09da450f0069",
"WorkTypeParentId": "a57db193-3195-461a-80b0-93d174e90b93",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "04581fac-2311-4914-a61a-7868b776b8ce",
"UPN": "4e315992-ae67-4310-8b8f-f19159580003",
"PostDate": "2026-07-22T06:59:59.2358789+00:00",
"Comment": "sample string 4",
"CC": [
"3d6b3790-5ea5-4b99-b9da-87767cb837ec",
"ec3c31d1-1367-4a5f-9d76-f0d1fc98f624"
],
"Users": [
"cbebe854-7d16-4683-80fe-579244ee69ac",
"bdcb06ae-7808-4c5b-808e-d4f3f58ae097"
]
},
{
"Id": "04581fac-2311-4914-a61a-7868b776b8ce",
"UPN": "4e315992-ae67-4310-8b8f-f19159580003",
"PostDate": "2026-07-22T06:59:59.2358789+00:00",
"Comment": "sample string 4",
"CC": [
"3d6b3790-5ea5-4b99-b9da-87767cb837ec",
"ec3c31d1-1367-4a5f-9d76-f0d1fc98f624"
],
"Users": [
"cbebe854-7d16-4683-80fe-579244ee69ac",
"bdcb06ae-7808-4c5b-808e-d4f3f58ae097"
]
}
],
"StartDate": "2026-07-22T06:59:59.2358789+00:00",
"DueDate": "2026-07-22T06:59:59.2358789+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"238754eb-e84c-462c-8ed5-fc259677149c": "d3686265-c764-4946-94c5-60f9a6eb1c7d",
"5a077aab-b9f9-472e-a059-4ed814ca5069": "b3714699-99a0-4bbd-b6da-1e92abd74b26"
},
"HasUpdates": true,
"Modified": "2026-07-22T06:59:59.2358789+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-07-22T06:59:59.2358789+00:00"
},
"LastComment": "2026-07-22T06:59:59.2358789+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2828615d-cb4c-4fec-bff6-7d28efb6196c",
"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": "a9ae95f1-eafe-4916-bca4-2d8937c910f7",
"id": "c54f7a27-123d-45b1-915c-7d94c3ff3124",
"ConfigId": "32a16821-fed7-4902-8f96-004b83ed1641"
}