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": "fae67eb1-3133-46e3-b2ab-17e0f6605a04",
"ParentTaskId": "9f03cde5-fc4f-4082-a89e-90f624991808",
"Integration": {
"IntegrationId": "86e5d831-6213-48d9-87bb-4235ef882fb8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"84abb44a-7c1c-455a-8e0e-2e2ee1fd455a": 2.0,
"e039abb7-2986-442b-b6bc-c362f2c9b88b": 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": "39053233-d468-493e-8b75-128f4f72ada6",
"Name": "sample string 1",
"Created": "2026-03-03T18:15:30.1227439+00:00",
"Modified": "2026-03-03T18:15:30.1227439+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5f9a90b3-645a-49ad-8279-bb0c3abef2c8",
"63453978-16a9-4f3a-b696-aaf1fc267c1b"
],
"NonLaborAssignments": [
{
"Id": "ef14bdb8-6cdf-4f55-a4fa-6ed0c57dbaac",
"ResourceId": "9a71dc02-2f46-4ae7-abd0-aae74dc1744a",
"Quantity": 3.0
},
{
"Id": "ef14bdb8-6cdf-4f55-a4fa-6ed0c57dbaac",
"ResourceId": "9a71dc02-2f46-4ae7-abd0-aae74dc1744a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9a25cdd5-4f9b-419f-952c-d24e11845031",
"Type": 0,
"ResourceId": "500ad138-acd0-4d3c-a3a6-fea339ef4767",
"Units": 3.0
},
{
"Id": "9a25cdd5-4f9b-419f-952c-d24e11845031",
"Type": 0,
"ResourceId": "500ad138-acd0-4d3c-a3a6-fea339ef4767",
"Units": 3.0
}
],
"ParentId": "dbc909c1-88ae-4b40-b476-74f469f8764e",
"WorkTypeParentId": "d7c3ebb0-f02a-497b-9129-db99902bb747",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b7ee7165-eec2-44bf-a4a7-0a001e4b7a59",
"UPN": "5f4ebf0e-f35b-40c4-974f-218437c904cc",
"PostDate": "2026-03-03T18:15:30.1227439+00:00",
"Comment": "sample string 4",
"CC": [
"25031c90-7022-44bd-864c-cad06bf9fe2b",
"d448ff1b-f86f-4254-bcee-6529ee1824ba"
],
"Users": [
"ae5c90ea-320c-44cd-9046-d08815502c09",
"06c32cae-aaa3-40a4-99b8-a14edf70f87f"
]
},
{
"Id": "b7ee7165-eec2-44bf-a4a7-0a001e4b7a59",
"UPN": "5f4ebf0e-f35b-40c4-974f-218437c904cc",
"PostDate": "2026-03-03T18:15:30.1227439+00:00",
"Comment": "sample string 4",
"CC": [
"25031c90-7022-44bd-864c-cad06bf9fe2b",
"d448ff1b-f86f-4254-bcee-6529ee1824ba"
],
"Users": [
"ae5c90ea-320c-44cd-9046-d08815502c09",
"06c32cae-aaa3-40a4-99b8-a14edf70f87f"
]
}
],
"StartDate": "2026-03-03T18:15:30.1227439+00:00",
"DueDate": "2026-03-03T18:15:30.1227439+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cead9f1e-1cad-448b-9365-2244dac1c4d0": "188437a2-823b-4bdc-bfce-50ed717dd05f",
"d71e87ba-0acf-44f2-ad8f-bb5bb94bf5e9": "ea459f37-0199-4e8a-97e0-5da6e328f07a"
},
"HasUpdates": true,
"Modified": "2026-03-03T18:15:30.1227439+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-03-03T18:15:30.1227439+00:00"
},
"LastComment": "2026-03-03T18:15:30.1227439+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e8c32da5-94ec-4886-ac1c-673d5ec2aa07",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "5f6aa901-35a9-4e25-9308-138dda8a1dc3",
"id": "6b2e465c-2496-4656-aaa7-830daa666ae4",
"ConfigId": "9f14d49a-6d62-4f96-8ea5-df47c8f497a2"
}