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": "3d678edc-b666-4268-be46-2f053a838703",
"ParentTaskId": "80c72bf1-ba77-4c87-8e69-b906a720112e",
"Integration": {
"IntegrationId": "4946744b-c96d-483e-af2f-3e87e0e3a0f5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c48048d6-3b21-440b-8d2f-b0ef2b083421": 2.0,
"69060c60-e0ae-43aa-8553-94e19df3ec95": 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": "3d6f280f-cf74-4ecd-916e-cc454cfaf266",
"Name": "sample string 1",
"Created": "2026-09-19T18:45:03.2778468+00:00",
"Modified": "2026-09-19T18:45:03.2778468+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2991ef6b-02a2-4d81-9762-865d7b077e71",
"c4cba759-3d02-448b-b001-a6a43fca4dd1"
],
"NonLaborAssignments": [
{
"Id": "b087640e-19b2-4fce-91cb-1f20bfdc2740",
"ResourceId": "c51e0f25-6e65-417f-bcc6-4265d554ad2d",
"Quantity": 3.0
},
{
"Id": "b087640e-19b2-4fce-91cb-1f20bfdc2740",
"ResourceId": "c51e0f25-6e65-417f-bcc6-4265d554ad2d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7b8f442d-144c-4982-a4c6-51abc4c016a9",
"Type": 0,
"ResourceId": "df5bead0-e9f8-408b-8132-56f416c06618",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0e8d43d7-dfbc-45ab-b1b0-583ab5520670",
"Start": "2026-09-19T18:45:03.2778468+00:00",
"Due": "2026-09-19T18:45:03.2778468+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0e8d43d7-dfbc-45ab-b1b0-583ab5520670",
"Start": "2026-09-19T18:45:03.2778468+00:00",
"Due": "2026-09-19T18:45:03.2778468+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7b8f442d-144c-4982-a4c6-51abc4c016a9",
"Type": 0,
"ResourceId": "df5bead0-e9f8-408b-8132-56f416c06618",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0e8d43d7-dfbc-45ab-b1b0-583ab5520670",
"Start": "2026-09-19T18:45:03.2778468+00:00",
"Due": "2026-09-19T18:45:03.2778468+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0e8d43d7-dfbc-45ab-b1b0-583ab5520670",
"Start": "2026-09-19T18:45:03.2778468+00:00",
"Due": "2026-09-19T18:45:03.2778468+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "d1f76c88-5cd1-449a-8cfe-b89b66f4ef13",
"WorkTypeParentId": "48f41cf9-2bfb-4026-a88c-b3106d674cc0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8864b9d4-dddf-4746-a6fc-a1c7666b461a",
"UPN": "f4c79df6-a6b8-4123-abd0-0c11646cf520",
"PostDate": "2026-09-19T18:45:03.2778468+00:00",
"Comment": "sample string 4",
"CC": [
"6dc9c4f9-6030-4ca8-a2ab-152cafaf32cf",
"0535c7ab-e6c1-46fd-9a6c-5f980dd98036"
],
"Users": [
"dc38b127-9e17-4078-9154-83a07d8283f5",
"b25be8d6-6ab4-4524-b856-6d5af3f37a22"
]
},
{
"Id": "8864b9d4-dddf-4746-a6fc-a1c7666b461a",
"UPN": "f4c79df6-a6b8-4123-abd0-0c11646cf520",
"PostDate": "2026-09-19T18:45:03.2778468+00:00",
"Comment": "sample string 4",
"CC": [
"6dc9c4f9-6030-4ca8-a2ab-152cafaf32cf",
"0535c7ab-e6c1-46fd-9a6c-5f980dd98036"
],
"Users": [
"dc38b127-9e17-4078-9154-83a07d8283f5",
"b25be8d6-6ab4-4524-b856-6d5af3f37a22"
]
}
],
"StartDate": "2026-09-19T18:45:03.2778468+00:00",
"DueDate": "2026-09-19T18:45:03.2778468+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"87b43f9c-75b9-453a-b43e-8d70b70335a9": "8b3795da-4499-43ef-bdfb-e8d36bf1dbc6",
"82b2a056-bfd7-4068-90a1-f175ddc35898": "3df64beb-48d4-498c-8dc7-99c7b2c81f64"
},
"HasUpdates": true,
"Modified": "2026-09-19T18:45:03.2778468+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-19T18:45:03.2778468+00:00"
},
"LastComment": "2026-09-19T18:45:03.2778468+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "07c24a38-379c-4d2b-86d2-3f8b2c9ce048",
"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": "54b38b3b-052a-470e-8460-7899dd5bcb79",
"id": "c0bb0949-7f9d-439a-a23e-2a281b72386e",
"ConfigId": "9ba4ec89-5deb-4865-9f67-cb8473bc5bb2"
}