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": "ffd042a9-8c0e-44f5-9a29-67d4a5458f53",
"ParentTaskId": "98a219a1-a812-42bd-840a-98fa52097428",
"Integration": {
"IntegrationId": "5b93ffa1-e9fe-45f3-82d1-40728553eaef",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"35766a77-805a-40fe-8fdd-b63e97349c79": 2.0,
"9cc880d1-50ec-41bc-965c-501f51598394": 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": "b8ea0f3e-a42c-45a2-af5b-61316637259f",
"Name": "sample string 1",
"Created": "2026-06-26T06:04:21.5090238+00:00",
"Modified": "2026-06-26T06:04:21.5090238+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"18cfb4ef-9c02-42de-90c0-32131ad5dc50",
"c48c1d4d-b2cb-406c-8f5c-bbdc8022f08d"
],
"NonLaborAssignments": [
{
"Id": "bd129db5-c34c-492a-803c-3332f2250a3f",
"ResourceId": "12882dde-09a6-41e1-834b-5f28dab365e6",
"Quantity": 3.0
},
{
"Id": "bd129db5-c34c-492a-803c-3332f2250a3f",
"ResourceId": "12882dde-09a6-41e1-834b-5f28dab365e6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7a328278-b19a-4c0c-a764-37f8997ebc0c",
"Type": 0,
"ResourceId": "abffb15b-e34a-4e8e-ba97-0f57c51c28ea",
"Units": 3.0
},
{
"Id": "7a328278-b19a-4c0c-a764-37f8997ebc0c",
"Type": 0,
"ResourceId": "abffb15b-e34a-4e8e-ba97-0f57c51c28ea",
"Units": 3.0
}
],
"ParentId": "490ce16b-9e17-4c83-acc8-7104835ec530",
"WorkTypeParentId": "104c9813-4d70-4717-aa7e-ca12ef37cd03",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "221bd0ad-e672-41d4-988b-9d5122a1cde5",
"UPN": "9f654338-e774-42d4-870e-5ed9e6551d94",
"PostDate": "2026-06-26T06:04:21.5090238+00:00",
"Comment": "sample string 4",
"CC": [
"3900c629-4fcc-40fa-9bdb-1dd589593f0d",
"735f0db5-d5a3-4796-93e9-2090610422f5"
],
"Users": [
"52a13b18-4cea-4d78-99a4-ed3ea2cac3c5",
"749c52f4-7b93-4d6e-b19b-3c3e1a0f4960"
]
},
{
"Id": "221bd0ad-e672-41d4-988b-9d5122a1cde5",
"UPN": "9f654338-e774-42d4-870e-5ed9e6551d94",
"PostDate": "2026-06-26T06:04:21.5090238+00:00",
"Comment": "sample string 4",
"CC": [
"3900c629-4fcc-40fa-9bdb-1dd589593f0d",
"735f0db5-d5a3-4796-93e9-2090610422f5"
],
"Users": [
"52a13b18-4cea-4d78-99a4-ed3ea2cac3c5",
"749c52f4-7b93-4d6e-b19b-3c3e1a0f4960"
]
}
],
"StartDate": "2026-06-26T06:04:21.5090238+00:00",
"DueDate": "2026-06-26T06:04:21.5090238+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2e040b58-d1af-4121-8dea-3407c91e674b": "ce415c2e-82b5-45ea-8061-76972c3f50e7",
"9e4e8112-161c-4756-b2ab-b099ec963795": "162748df-66a3-46ed-863d-c27fc3c4ad55"
},
"HasUpdates": true,
"Modified": "2026-06-26T06:04:21.5090238+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-26T06:04:21.5090238+00:00"
},
"LastComment": "2026-06-26T06:04:21.5090238+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1cf9cde6-999e-40c8-9462-74aaffe08ce6",
"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": "4a577376-67c3-48f2-9dbe-a79bbe743f66",
"id": "c2d2666a-1a5a-4f26-8ed9-8ef62d907f7e",
"ConfigId": "e4920d77-ad44-4a1a-93eb-2dc36b7dfe6d"
}