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": "d35f6712-5e99-4413-bd52-10106f4a4562",
"ParentTaskId": "91a3aa99-6898-4c70-a8ab-f1e34ae88543",
"Integration": {
"IntegrationId": "777f7431-8c60-4e33-b398-e4883a91cfcf",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e63291ee-83e9-4897-9e6e-8412dc5bbd44": 2.0,
"b2d31867-3e58-4542-ad45-80f4ae831dbe": 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": "e08de9db-1a05-4240-88c6-49c6a901681c",
"Name": "sample string 1",
"Created": "2026-10-03T11:44:26.6559436+00:00",
"Modified": "2026-10-03T11:44:26.6559436+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"42471521-c071-4abd-a6ad-ecdf2c25d645",
"b782cba2-2ddd-40b3-bbad-08e8ee8151d3"
],
"NonLaborAssignments": [
{
"Id": "cf95f2b1-d226-42ed-8393-136b6c49d5a8",
"ResourceId": "ad370751-0b6c-4b4c-ad1c-50a6b45ab997",
"Quantity": 3.0
},
{
"Id": "cf95f2b1-d226-42ed-8393-136b6c49d5a8",
"ResourceId": "ad370751-0b6c-4b4c-ad1c-50a6b45ab997",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "82ee2fff-8104-4034-acc2-34d6212f5427",
"Type": 0,
"ResourceId": "46996706-69ba-4e31-a6d5-bea306cd2ac3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "668a669e-e8b4-4755-9b80-ecc47975fc9d",
"Start": "2026-10-03T11:44:26.6559436+00:00",
"Due": "2026-10-03T11:44:26.6559436+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "668a669e-e8b4-4755-9b80-ecc47975fc9d",
"Start": "2026-10-03T11:44:26.6559436+00:00",
"Due": "2026-10-03T11:44:26.6559436+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "82ee2fff-8104-4034-acc2-34d6212f5427",
"Type": 0,
"ResourceId": "46996706-69ba-4e31-a6d5-bea306cd2ac3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "668a669e-e8b4-4755-9b80-ecc47975fc9d",
"Start": "2026-10-03T11:44:26.6559436+00:00",
"Due": "2026-10-03T11:44:26.6559436+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "668a669e-e8b4-4755-9b80-ecc47975fc9d",
"Start": "2026-10-03T11:44:26.6559436+00:00",
"Due": "2026-10-03T11:44:26.6559436+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "513981c1-c7be-4318-b6ae-eb0eb017b3d6",
"WorkTypeParentId": "7d7b15b5-206c-4fc4-bf35-f0e714ffb448",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6a80d465-f662-49c1-8b94-2bafbfde0fde",
"UPN": "362ebc33-e68e-47f6-a6c4-f205e720fd8b",
"PostDate": "2026-10-03T11:44:26.6559436+00:00",
"Comment": "sample string 4",
"CC": [
"2d98f943-1908-4998-a966-18004ccb979b",
"bfbbb8ee-c800-49c6-bb08-e52efa5b7f14"
],
"Users": [
"60606178-c75f-4f7a-b0d1-a79dd2d6e048",
"2319a929-19bc-4470-90e6-df8b77c58664"
]
},
{
"Id": "6a80d465-f662-49c1-8b94-2bafbfde0fde",
"UPN": "362ebc33-e68e-47f6-a6c4-f205e720fd8b",
"PostDate": "2026-10-03T11:44:26.6559436+00:00",
"Comment": "sample string 4",
"CC": [
"2d98f943-1908-4998-a966-18004ccb979b",
"bfbbb8ee-c800-49c6-bb08-e52efa5b7f14"
],
"Users": [
"60606178-c75f-4f7a-b0d1-a79dd2d6e048",
"2319a929-19bc-4470-90e6-df8b77c58664"
]
}
],
"StartDate": "2026-10-03T11:44:26.6559436+00:00",
"DueDate": "2026-10-03T11:44:26.6559436+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bdc03d39-a3b4-4e38-b03a-a4f9be0b44d1": "e9011490-00fc-4bd5-a544-4bcda4707bf2",
"0ac4cde7-458a-49db-86ad-e2c08301166f": "e21f6232-3adc-4610-9fa4-31cb79d5b21e"
},
"HasUpdates": true,
"Modified": "2026-10-03T11:44:26.6559436+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-10-03T11:44:26.6559436+00:00"
},
"LastComment": "2026-10-03T11:44:26.6559436+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "601577f7-5ab2-468c-8108-8eed7d588bfa",
"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": "009a8a0e-4d8f-4842-a96c-53285a55d7f1",
"id": "962780ef-d125-420a-82f6-361c21eb6fe4",
"ConfigId": "c316ce36-054d-4967-adbd-7d9b08496c23"
}