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": "78763929-3cdb-40fc-a798-49c46a500542",
"ParentTaskId": "3da23eca-e0f7-4d5b-a71c-ba03db17a5c0",
"Integration": {
"IntegrationId": "86a039d8-124c-44c1-ac66-edbad044ae4e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4b680e48-ba8e-4bb3-87ed-7cb07baeaf27": 2.0,
"7875e4a5-e56c-4d92-86f0-3c34c1b9f78c": 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": "a5951620-d2b0-4e50-be62-351bf3bcbe56",
"Name": "sample string 1",
"Created": "2026-11-05T10:27:08.7434833+00:00",
"Modified": "2026-11-05T10:27:08.7434833+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9233bfb3-d885-4419-807a-8769e4d50bec",
"9645f824-ac08-4f07-9704-1a96c6889b95"
],
"NonLaborAssignments": [
{
"Id": "54425e18-f5e7-4b0a-b6e5-a0cf0c0a67bd",
"ResourceId": "6268dbcf-baa3-42f6-9afd-abc3281def80",
"Quantity": 3.0
},
{
"Id": "54425e18-f5e7-4b0a-b6e5-a0cf0c0a67bd",
"ResourceId": "6268dbcf-baa3-42f6-9afd-abc3281def80",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "be4c7b49-d07d-4a81-9932-100f7ca1df64",
"Type": 0,
"ResourceId": "c9ab5930-2d66-4189-9af0-1d84e31c4b5d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3858af48-06ba-4369-af73-211fa7cf7531",
"Start": "2026-11-05T10:27:08.7434833+00:00",
"Due": "2026-11-05T10:27:08.7434833+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3858af48-06ba-4369-af73-211fa7cf7531",
"Start": "2026-11-05T10:27:08.7434833+00:00",
"Due": "2026-11-05T10:27:08.7434833+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "be4c7b49-d07d-4a81-9932-100f7ca1df64",
"Type": 0,
"ResourceId": "c9ab5930-2d66-4189-9af0-1d84e31c4b5d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3858af48-06ba-4369-af73-211fa7cf7531",
"Start": "2026-11-05T10:27:08.7434833+00:00",
"Due": "2026-11-05T10:27:08.7434833+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3858af48-06ba-4369-af73-211fa7cf7531",
"Start": "2026-11-05T10:27:08.7434833+00:00",
"Due": "2026-11-05T10:27:08.7434833+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f2b1f357-ceb9-4754-b5af-db73229546b7",
"WorkTypeParentId": "edc84e9b-a26c-40c5-806b-50652829a5a4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b7e5793b-551b-4e30-8b8c-d11943e264cd",
"UPN": "6361360a-ef5f-4f1a-bf4c-77089cf77bcf",
"PostDate": "2026-11-05T10:27:08.7434833+00:00",
"Comment": "sample string 4",
"CC": [
"bc64f510-888e-4242-b744-9a5ce12d6f99",
"2c84bdaa-8920-4092-a4f7-aeb36136a0fc"
],
"Users": [
"79ad0810-6e50-4909-aac1-28e7f858fd25",
"620ca4b5-3524-46f0-9f19-26ce1f8e7ca2"
]
},
{
"Id": "b7e5793b-551b-4e30-8b8c-d11943e264cd",
"UPN": "6361360a-ef5f-4f1a-bf4c-77089cf77bcf",
"PostDate": "2026-11-05T10:27:08.7434833+00:00",
"Comment": "sample string 4",
"CC": [
"bc64f510-888e-4242-b744-9a5ce12d6f99",
"2c84bdaa-8920-4092-a4f7-aeb36136a0fc"
],
"Users": [
"79ad0810-6e50-4909-aac1-28e7f858fd25",
"620ca4b5-3524-46f0-9f19-26ce1f8e7ca2"
]
}
],
"StartDate": "2026-11-05T10:27:08.7434833+00:00",
"DueDate": "2026-11-05T10:27:08.7434833+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d28050fe-4e91-4e64-b6ad-20c88efa22fb": "0089d3be-578d-4198-83e9-c50be2deb7f2",
"bc0a29e2-2b26-42e2-9eeb-173a41a8f93d": "0102da7c-a36b-44cc-9f72-edd97433d92d"
},
"HasUpdates": true,
"Modified": "2026-11-05T10:27:08.7434833+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-11-05T10:27:08.7434833+00:00"
},
"LastComment": "2026-11-05T10:27:08.7434833+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c97e72bc-7bda-4eaa-a460-fcfb62905d17",
"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": "dbd97d28-0cf9-4896-9f12-918a9d20c5c6",
"id": "97de5c86-e6a4-43f5-909b-065b4791c2bb",
"ConfigId": "9ae651ce-1608-4ec2-a48e-0109fd6598fb"
}