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": "3381866d-62bc-4e06-b0fe-f496c0d37824",
"ParentTaskId": "c17870f0-cfa8-4c49-a360-4017f2f4f42f",
"Integration": {
"IntegrationId": "5c668523-cb89-469f-a111-51db9bbb1e22",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0c038d81-5040-40b1-9c45-190cbcfd9090": 2.0,
"1a776c0c-8c09-4d8c-b73d-6f80a069c893": 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": "9c92156a-a8ab-421f-aadc-d30c78729d4a",
"Name": "sample string 1",
"Created": "2026-09-16T10:32:21.1819907+00:00",
"Modified": "2026-09-16T10:32:21.1819907+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cc861392-a9fd-4a1a-83f7-4d0a012ae74e",
"43e0d768-224f-4eed-a048-83d11a3ab593"
],
"NonLaborAssignments": [
{
"Id": "fd706d3b-9d13-427d-9b03-d45754eb12b4",
"ResourceId": "2a885338-8ac8-4fc8-b26c-126a7e20bd77",
"Quantity": 3.0
},
{
"Id": "fd706d3b-9d13-427d-9b03-d45754eb12b4",
"ResourceId": "2a885338-8ac8-4fc8-b26c-126a7e20bd77",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5c825761-8e0f-4f6b-80b0-0734db6c0808",
"Type": 0,
"ResourceId": "7e77870b-003f-434b-b3f4-d4b07beaf653",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "4b526c41-5d12-4128-9416-d3a18f8018bb",
"Start": "2026-09-16T10:32:21.1819907+00:00",
"Due": "2026-09-16T10:32:21.1819907+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "4b526c41-5d12-4128-9416-d3a18f8018bb",
"Start": "2026-09-16T10:32:21.1819907+00:00",
"Due": "2026-09-16T10:32:21.1819907+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "5c825761-8e0f-4f6b-80b0-0734db6c0808",
"Type": 0,
"ResourceId": "7e77870b-003f-434b-b3f4-d4b07beaf653",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "4b526c41-5d12-4128-9416-d3a18f8018bb",
"Start": "2026-09-16T10:32:21.1819907+00:00",
"Due": "2026-09-16T10:32:21.1819907+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "4b526c41-5d12-4128-9416-d3a18f8018bb",
"Start": "2026-09-16T10:32:21.1819907+00:00",
"Due": "2026-09-16T10:32:21.1819907+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "10fea063-75f9-413f-a09f-884c7d2f7f1e",
"WorkTypeParentId": "f8250955-0096-40ee-818a-702fdfcdfd40",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "32dfc601-e3bd-4dad-abea-520932c0a50b",
"UPN": "a4b2c2a8-db2c-4406-8e14-8a5e2bbc0e15",
"PostDate": "2026-09-16T10:32:21.1819907+00:00",
"Comment": "sample string 4",
"CC": [
"df10bfba-4fcc-40e7-b11e-1b416472699e",
"40d35bf4-8bb0-4e8e-b012-d8ee11d89720"
],
"Users": [
"b5216ba7-3966-476c-b16d-09491257b27b",
"bae49570-849a-4c8b-8291-ba9128518750"
]
},
{
"Id": "32dfc601-e3bd-4dad-abea-520932c0a50b",
"UPN": "a4b2c2a8-db2c-4406-8e14-8a5e2bbc0e15",
"PostDate": "2026-09-16T10:32:21.1819907+00:00",
"Comment": "sample string 4",
"CC": [
"df10bfba-4fcc-40e7-b11e-1b416472699e",
"40d35bf4-8bb0-4e8e-b012-d8ee11d89720"
],
"Users": [
"b5216ba7-3966-476c-b16d-09491257b27b",
"bae49570-849a-4c8b-8291-ba9128518750"
]
}
],
"StartDate": "2026-09-16T10:32:21.1819907+00:00",
"DueDate": "2026-09-16T10:32:21.1819907+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"85ae2d82-b561-44df-8446-a24b849d71c5": "955d6f2c-8e11-4db4-a25c-5ff6efb19f9c",
"0e1acd98-8d89-4024-bd0f-9908cbb6cd82": "11df5ccd-2400-434a-9148-814846e58e54"
},
"HasUpdates": true,
"Modified": "2026-09-16T10:32:21.1819907+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-16T10:32:21.1819907+00:00"
},
"LastComment": "2026-09-16T10:32:21.1819907+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "eb2627b0-8950-4184-a84e-c5d2c33edf00",
"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": "1b33e932-781d-4313-bb64-204f92f36392",
"id": "d43e0b46-f931-465f-8385-636fd16aa5a6",
"ConfigId": "492ca7c6-c778-412e-8887-ec9d548a6e70"
}