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": "3cba0573-82e9-4519-9680-4a7f35acbdde",
"ParentTaskId": "cc1985f7-a0b6-47db-a4bb-1a3de67422e1",
"Integration": {
"IntegrationId": "19dec4f9-4463-40b4-b7dd-103b2214bd19",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"73b19ad2-2307-4cd4-9103-c63836f9660c": 2.0,
"57452342-c694-4a3f-acd8-7fd22acf7ee1": 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": "6ac3008a-f348-4a67-8d86-ae722e5fc8c9",
"Name": "sample string 1",
"Created": "2026-09-28T15:50:16.0584949+00:00",
"Modified": "2026-09-28T15:50:16.0584949+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"fd9762fc-ac1d-4510-ab16-eb0942c2fe19",
"e097dd7a-ca80-42a6-ada7-125abbfdf316"
],
"NonLaborAssignments": [
{
"Id": "c01db497-6c66-446b-ac88-d278f0662312",
"ResourceId": "5dcf028b-e25d-4f5c-9e87-ffd17a98665a",
"Quantity": 3.0
},
{
"Id": "c01db497-6c66-446b-ac88-d278f0662312",
"ResourceId": "5dcf028b-e25d-4f5c-9e87-ffd17a98665a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "627900b3-b449-4c32-9b5d-6fd779f4267d",
"Type": 0,
"ResourceId": "19be373c-da11-4b49-90b8-b3737706725b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c6a576fa-b8c4-4f2f-8aad-69d5074b1741",
"Start": "2026-09-28T15:50:16.0584949+00:00",
"Due": "2026-09-28T15:50:16.0584949+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c6a576fa-b8c4-4f2f-8aad-69d5074b1741",
"Start": "2026-09-28T15:50:16.0584949+00:00",
"Due": "2026-09-28T15:50:16.0584949+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "627900b3-b449-4c32-9b5d-6fd779f4267d",
"Type": 0,
"ResourceId": "19be373c-da11-4b49-90b8-b3737706725b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c6a576fa-b8c4-4f2f-8aad-69d5074b1741",
"Start": "2026-09-28T15:50:16.0584949+00:00",
"Due": "2026-09-28T15:50:16.0584949+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c6a576fa-b8c4-4f2f-8aad-69d5074b1741",
"Start": "2026-09-28T15:50:16.0584949+00:00",
"Due": "2026-09-28T15:50:16.0584949+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f5b59b33-442e-405c-8b88-e285a0346d5a",
"WorkTypeParentId": "59c97a83-bd6c-47b1-adcd-e6f6998c8b6d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4f12ca1a-6cb0-447b-bfa4-91c88fd01092",
"UPN": "bbd871cc-b0f0-4e41-ae54-a6300d025400",
"PostDate": "2026-09-28T15:50:16.0584949+00:00",
"Comment": "sample string 4",
"CC": [
"1e9188d6-58c0-4ee6-a14c-d2f4444b70d3",
"65f85f16-cc64-458a-aaa3-9b67eee0627f"
],
"Users": [
"395bf42f-6cbf-4a27-81ca-4a2e5cdcc603",
"e5a4e292-21db-4d0a-a92d-b93569957778"
]
},
{
"Id": "4f12ca1a-6cb0-447b-bfa4-91c88fd01092",
"UPN": "bbd871cc-b0f0-4e41-ae54-a6300d025400",
"PostDate": "2026-09-28T15:50:16.0584949+00:00",
"Comment": "sample string 4",
"CC": [
"1e9188d6-58c0-4ee6-a14c-d2f4444b70d3",
"65f85f16-cc64-458a-aaa3-9b67eee0627f"
],
"Users": [
"395bf42f-6cbf-4a27-81ca-4a2e5cdcc603",
"e5a4e292-21db-4d0a-a92d-b93569957778"
]
}
],
"StartDate": "2026-09-28T15:50:16.0584949+00:00",
"DueDate": "2026-09-28T15:50:16.0584949+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e63711a7-caf2-4c46-a2e3-5ef23d04cb4e": "c116b561-23c9-4694-8a27-a816f2c867e9",
"75ac4c37-1277-460b-a0b7-85d7bd6b0cac": "6ad501c0-215d-466d-8728-fc74fe2dab98"
},
"HasUpdates": true,
"Modified": "2026-09-28T15:50:16.0584949+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-09-28T15:50:16.0584949+00:00"
},
"LastComment": "2026-09-28T15:50:16.0584949+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "fb0a4ae8-9eba-43b4-b33d-9682ffae2b51",
"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": "65eb0e8f-a267-43de-88f3-3d81af485e7e",
"id": "c52c4a68-7c89-4c73-bf43-540d23021979",
"ConfigId": "61335c1e-81c7-4ad5-90db-3b9193850786"
}