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": "67170ade-2286-4025-9434-239c16626da3",
"ParentTaskId": "eae16b5e-6a4c-4ebd-b8ef-daa063969e7e",
"Integration": {
"IntegrationId": "ccf0745a-1058-4249-a120-e78010bc2da9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"08514e19-ad82-4d7b-80c4-bf48cb47d47d": 2.0,
"5a21454f-1c06-43c4-86eb-44f642a3c587": 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": "0ff15de6-2698-42cc-8746-1b483c2cdf61",
"Name": "sample string 1",
"Created": "2026-07-04T05:30:28.1500169+00:00",
"Modified": "2026-07-04T05:30:28.1500169+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"968ad1b6-9eb3-4b10-b1de-636e3a587bfc",
"a12d1860-5afb-46dc-8e06-6a2864af8613"
],
"NonLaborAssignments": [
{
"Id": "2348e9a6-a73b-430c-ad50-2f0ff5027f5b",
"ResourceId": "2dab5ac2-606d-4f96-9876-18869e730d59",
"Quantity": 3.0
},
{
"Id": "2348e9a6-a73b-430c-ad50-2f0ff5027f5b",
"ResourceId": "2dab5ac2-606d-4f96-9876-18869e730d59",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d5b635bd-5a2b-47a5-b4f6-276c123f5ca0",
"Type": 0,
"ResourceId": "01a78c80-a1c3-431c-b042-6f382edfe081",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "d5b635bd-5a2b-47a5-b4f6-276c123f5ca0",
"Type": 0,
"ResourceId": "01a78c80-a1c3-431c-b042-6f382edfe081",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "650dac3a-1cc9-4afa-9ca3-8d70afbb7337",
"WorkTypeParentId": "ced3465d-56ec-40a2-968c-90022a031d5a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2d9942d9-71a2-4a92-a44a-51a80b447ca2",
"UPN": "a822bcd2-c809-4548-805f-2a6e9f6fbe71",
"PostDate": "2026-07-04T05:30:28.165655+00:00",
"Comment": "sample string 4",
"CC": [
"233683a2-cd62-4265-ba92-b4399c132a14",
"26192937-1456-4822-afe7-6392c54358b3"
],
"Users": [
"0ba2aac5-7739-4dfd-bbed-7af61428ae7e",
"eb4ed546-43fc-460a-945a-5db1cd05eaaf"
]
},
{
"Id": "2d9942d9-71a2-4a92-a44a-51a80b447ca2",
"UPN": "a822bcd2-c809-4548-805f-2a6e9f6fbe71",
"PostDate": "2026-07-04T05:30:28.165655+00:00",
"Comment": "sample string 4",
"CC": [
"233683a2-cd62-4265-ba92-b4399c132a14",
"26192937-1456-4822-afe7-6392c54358b3"
],
"Users": [
"0ba2aac5-7739-4dfd-bbed-7af61428ae7e",
"eb4ed546-43fc-460a-945a-5db1cd05eaaf"
]
}
],
"StartDate": "2026-07-04T05:30:28.165655+00:00",
"DueDate": "2026-07-04T05:30:28.165655+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"67a5256c-f775-42b2-9c89-33a9b23c4f25": "2405ee20-08d3-4eea-bd60-b5ddbf5e300a",
"0bd38a98-c508-4c1e-8e17-99ee63854dc6": "ca95377c-9c27-4906-a0cb-4630e9331f7c"
},
"HasUpdates": true,
"Modified": "2026-07-04T05:30:28.165655+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-04T05:30:28.165655+00:00"
},
"LastComment": "2026-07-04T05:30:28.165655+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f3794ca1-bbf6-4b23-b659-a362ed88b6ab",
"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": "6aeee8d5-99f3-4755-8020-30cbe85f649d",
"id": "ac87143e-56b4-4ba7-acd6-87a6601a4c79",
"ConfigId": "26027c22-23fd-4e38-8ea6-dd4f3222d96a"
}