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": "542d9a96-ecd2-40bf-8a5e-121d98883cb4",
"ParentTaskId": "696d8a5d-cd1f-497d-9e92-22f9a6f27dec",
"Integration": {
"IntegrationId": "99606873-4929-4e20-b5e7-cd30b82e4590",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"02addc59-669e-42e4-864f-c1adcfb183f5": 2.0,
"e1ee0d9c-1453-4ae4-8791-139f3f06ec64": 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": "5fd41a3c-3117-494a-81ca-cb8e1d5ec0f2",
"Name": "sample string 1",
"Created": "2026-06-03T00:04:36.8046178+00:00",
"Modified": "2026-06-03T00:04:36.8046178+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a687dfce-04e5-44bb-8048-d68c77122380",
"e0255beb-24e4-4c63-9a82-62263a760461"
],
"NonLaborAssignments": [
{
"Id": "8f95da01-adae-47c1-9447-e5b35c2d45a4",
"ResourceId": "82a9ce85-27dd-4eaa-b1b4-18d7d1d38e03",
"Quantity": 3.0
},
{
"Id": "8f95da01-adae-47c1-9447-e5b35c2d45a4",
"ResourceId": "82a9ce85-27dd-4eaa-b1b4-18d7d1d38e03",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7c48a46c-b8f7-43c8-a6ae-48fd35b38d9f",
"Type": 0,
"ResourceId": "8c0fb704-4523-40cb-8d41-762e26de7b3b",
"Units": 3.0
},
{
"Id": "7c48a46c-b8f7-43c8-a6ae-48fd35b38d9f",
"Type": 0,
"ResourceId": "8c0fb704-4523-40cb-8d41-762e26de7b3b",
"Units": 3.0
}
],
"ParentId": "1c42ff02-1b13-4e40-9a8a-8ae26ecd1a2e",
"WorkTypeParentId": "f0fdd4fd-a357-4d80-9c1b-d4b5a2f85adc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "27057380-a801-4643-aee5-6b5d33e7a2f3",
"UPN": "a3519f46-4ace-43cb-aa60-d7485dce9cf0",
"PostDate": "2026-06-03T00:04:36.8046178+00:00",
"Comment": "sample string 4",
"CC": [
"8abaa766-3494-47df-9434-e0b9fabaea5d",
"1aa605d1-90b2-4e3c-91b7-0c996e26715e"
],
"Users": [
"9f086df2-0730-4171-a23d-1a658c6361a7",
"d9b9a3cb-8731-4618-9966-fa58811ee616"
]
},
{
"Id": "27057380-a801-4643-aee5-6b5d33e7a2f3",
"UPN": "a3519f46-4ace-43cb-aa60-d7485dce9cf0",
"PostDate": "2026-06-03T00:04:36.8046178+00:00",
"Comment": "sample string 4",
"CC": [
"8abaa766-3494-47df-9434-e0b9fabaea5d",
"1aa605d1-90b2-4e3c-91b7-0c996e26715e"
],
"Users": [
"9f086df2-0730-4171-a23d-1a658c6361a7",
"d9b9a3cb-8731-4618-9966-fa58811ee616"
]
}
],
"StartDate": "2026-06-03T00:04:36.8046178+00:00",
"DueDate": "2026-06-03T00:04:36.8046178+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"8b4acf60-c796-4a7b-86f9-dfa41f9a0eb5": "177949cd-90f2-4831-9a3f-23c65865613f",
"cac31726-38e9-49d3-91f4-72970785d078": "c55d6365-eb5b-42ba-94e3-f36e583e65ea"
},
"HasUpdates": true,
"Modified": "2026-06-03T00:04:36.8046178+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-06-03T00:04:36.8046178+00:00"
},
"LastComment": "2026-06-03T00:04:36.8046178+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "fed1d228-ac65-4847-b80b-251b819f9343",
"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": "9d2e97e2-28be-47ea-9b4a-66c2228147bf",
"id": "50c3b7f4-4781-4900-8eba-67de1b2a8f87",
"ConfigId": "2b888154-4575-4295-a512-398120d214bd"
}