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": "39a84303-9ee8-464a-a3a6-1f0df0bcac28",
"ParentTaskId": "9e6a8d58-262c-4072-9c3d-946d7309aec9",
"Integration": {
"IntegrationId": "1101fa8d-bc97-4053-9ed4-8c387c74ec46",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"587adbaf-6bc2-4ba5-89af-5ebeea52f38b": 2.0,
"6c7c7dc5-3ba2-43eb-9bfd-3ee73f2926f5": 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": "a3fbbd06-bc76-4667-af0c-ad9578b5c183",
"Name": "sample string 1",
"Created": "2026-06-06T22:00:46.5122559+00:00",
"Modified": "2026-06-06T22:00:46.5122559+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5552eeb4-be6b-4643-a2ca-d7ddf6bac286",
"25cff8a7-b25e-42b7-a47f-08d2e7d37a46"
],
"NonLaborAssignments": [
{
"Id": "a6937387-d5b2-4d1a-bb05-bedfcec18bdf",
"ResourceId": "d3713021-8c5a-4e2f-afd6-a2de9625ab63",
"Quantity": 3.0
},
{
"Id": "a6937387-d5b2-4d1a-bb05-bedfcec18bdf",
"ResourceId": "d3713021-8c5a-4e2f-afd6-a2de9625ab63",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ebad1948-5995-422b-a23d-d4f4e38bfecc",
"Type": 0,
"ResourceId": "7f3b4637-6fd2-421a-969a-0026aaadb9d6",
"Units": 3.0
},
{
"Id": "ebad1948-5995-422b-a23d-d4f4e38bfecc",
"Type": 0,
"ResourceId": "7f3b4637-6fd2-421a-969a-0026aaadb9d6",
"Units": 3.0
}
],
"ParentId": "f75d9ed7-2e51-4687-ac56-a969b8786ffd",
"WorkTypeParentId": "29486444-ad63-4355-9802-ef43d88ae4f2",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "36ed9758-aa29-498c-af85-2fd185a63001",
"UPN": "4a8de4cf-2391-42df-bd5f-60f54f09f5e6",
"PostDate": "2026-06-06T22:00:46.5122559+00:00",
"Comment": "sample string 4",
"CC": [
"8130b257-4fc4-46a4-9fd4-ded15bc903ac",
"54a52e03-723b-4e48-b4d2-949770eace19"
],
"Users": [
"c3d82e78-6e06-46cc-9c01-a18ee77f6573",
"54731648-9835-43c6-b2d6-de4db282c233"
]
},
{
"Id": "36ed9758-aa29-498c-af85-2fd185a63001",
"UPN": "4a8de4cf-2391-42df-bd5f-60f54f09f5e6",
"PostDate": "2026-06-06T22:00:46.5122559+00:00",
"Comment": "sample string 4",
"CC": [
"8130b257-4fc4-46a4-9fd4-ded15bc903ac",
"54a52e03-723b-4e48-b4d2-949770eace19"
],
"Users": [
"c3d82e78-6e06-46cc-9c01-a18ee77f6573",
"54731648-9835-43c6-b2d6-de4db282c233"
]
}
],
"StartDate": "2026-06-06T22:00:46.5122559+00:00",
"DueDate": "2026-06-06T22:00:46.5122559+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1e298e2f-9a03-4465-9c28-575b6954bcd1": "19dd51f0-01a3-4461-9ff3-883da90b620e",
"1a646328-3ff3-4ed8-8cb6-5f0b4a06ee21": "1fa4241c-64c4-4e5d-bd6d-2f28256a6dcc"
},
"HasUpdates": true,
"Modified": "2026-06-06T22:00:46.5122559+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-06T22:00:46.5122559+00:00"
},
"LastComment": "2026-06-06T22:00:46.5122559+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1d413000-50fb-4623-8e3d-eae577ea9905",
"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": "76d56917-74de-4bc2-89e3-b141f42b8005",
"id": "8a42c4e1-de48-4d08-918f-59d2a205495b",
"ConfigId": "81aae329-94c1-48d8-9bed-904e1cfd5b7c"
}