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": "ad875a1a-c6a3-41a6-b350-6921bce75bed",
"ParentTaskId": "a327a2e6-cf7b-446b-8b8a-d44ede3d0335",
"Integration": {
"IntegrationId": "b771dacc-c429-4c83-a74a-19d52de8dbd8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fc62ca92-c6ae-4a97-82b3-04c848918dd0": 2.0,
"6ec53cf6-bf7e-4fd4-8b69-3bdb48e5a891": 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": "8f19eb83-d01e-4586-9180-f0bd3ebdc85f",
"Name": "sample string 1",
"Created": "2026-04-02T12:26:16.5197348+00:00",
"Modified": "2026-04-02T12:26:16.5197348+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c4f9ecf1-5cfc-4c4a-b67b-f72eb5593c2d",
"a8b7a28f-b2da-45f7-ab73-cc4203041471"
],
"NonLaborAssignments": [
{
"Id": "bf69ac98-77d7-4966-9c52-c3049a18e73e",
"ResourceId": "c5dd5cd0-1854-4a72-a28e-f413ee0776c2",
"Quantity": 3.0
},
{
"Id": "bf69ac98-77d7-4966-9c52-c3049a18e73e",
"ResourceId": "c5dd5cd0-1854-4a72-a28e-f413ee0776c2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "64c80f5c-eb48-4ca6-a20e-35c11125be52",
"Type": 0,
"ResourceId": "d6343827-d2a9-4365-8cee-142e439be648",
"Units": 3.0
},
{
"Id": "64c80f5c-eb48-4ca6-a20e-35c11125be52",
"Type": 0,
"ResourceId": "d6343827-d2a9-4365-8cee-142e439be648",
"Units": 3.0
}
],
"ParentId": "40b56bff-7ae3-426e-859e-202c820d00a0",
"WorkTypeParentId": "e00b0055-d5a9-4a94-91f6-47f3183c0d2b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e080fa1f-02c6-4134-8324-dad62d0ca7dc",
"UPN": "0ca32609-305e-4b58-9227-1a6e5e6c0224",
"PostDate": "2026-04-02T12:26:16.5197348+00:00",
"Comment": "sample string 4",
"CC": [
"1b6280e4-f4d9-4f11-b76e-1cd053cc4931",
"c9bbf12c-1c64-4c00-b01c-22f94e134f0e"
],
"Users": [
"e2237817-7a5d-4b06-a0e2-88f821f49c6e",
"63c5b951-611d-4516-9927-03d13d8bc41d"
]
},
{
"Id": "e080fa1f-02c6-4134-8324-dad62d0ca7dc",
"UPN": "0ca32609-305e-4b58-9227-1a6e5e6c0224",
"PostDate": "2026-04-02T12:26:16.5197348+00:00",
"Comment": "sample string 4",
"CC": [
"1b6280e4-f4d9-4f11-b76e-1cd053cc4931",
"c9bbf12c-1c64-4c00-b01c-22f94e134f0e"
],
"Users": [
"e2237817-7a5d-4b06-a0e2-88f821f49c6e",
"63c5b951-611d-4516-9927-03d13d8bc41d"
]
}
],
"StartDate": "2026-04-02T12:26:16.5197348+00:00",
"DueDate": "2026-04-02T12:26:16.5197348+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3d51f55e-69c1-4933-bc8b-b25d09004f24": "eefb0c38-5076-4fdd-83a5-ec018550845e",
"d1990fc4-c879-4994-ad02-0fc98e766bb8": "3296e09c-623f-413d-8a68-25917e7ff119"
},
"HasUpdates": true,
"Modified": "2026-04-02T12:26:16.5197348+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-04-02T12:26:16.5197348+00:00"
},
"LastComment": "2026-04-02T12:26:16.5197348+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a77970a0-6e4e-412b-8dd6-0a0d4dc46e77",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "ac5e13e2-beff-4a06-9a91-8bd632e7e4f4",
"id": "d96b75e1-776b-4da1-b19f-10f4ef2b672f",
"ConfigId": "0b91577b-3548-44c3-a107-d8fce293f297"
}