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": "b4b39674-a5c3-4099-9916-f561db86e6dc",
"ParentTaskId": "afa84ac4-238b-47e0-a681-86ab56d192eb",
"Integration": {
"IntegrationId": "b9fe0b44-5e9e-43cf-9a86-55296473cf55",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"202cd528-09c4-44e9-99f6-a00b7914aadf": 2.0,
"1d3f70bd-fdc0-406d-834c-124b1f855993": 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": "180eb85d-c9c6-4a2f-90f7-4217ceff99b6",
"Name": "sample string 1",
"Created": "2026-09-22T12:32:06.7617402+00:00",
"Modified": "2026-09-22T12:32:06.7617402+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8334a72b-7cd9-49a9-8a9a-5485facc72da",
"84310468-8728-468a-ab84-f2b67ae642ad"
],
"NonLaborAssignments": [
{
"Id": "e7ee100d-09d4-45ce-98d9-f384f6afbcfc",
"ResourceId": "0d03f322-09cb-4c3d-9210-7af776ad4050",
"Quantity": 3.0
},
{
"Id": "e7ee100d-09d4-45ce-98d9-f384f6afbcfc",
"ResourceId": "0d03f322-09cb-4c3d-9210-7af776ad4050",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5a4a35c7-1ed0-4098-b667-b0e2b8f9e6e3",
"Type": 0,
"ResourceId": "82c6ffcb-218e-4fa9-bf36-7675712097b4",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "e2660186-4804-4873-943c-08d0ab27218a",
"Start": "2026-09-22T12:32:06.7773645+00:00",
"Due": "2026-09-22T12:32:06.7773645+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "e2660186-4804-4873-943c-08d0ab27218a",
"Start": "2026-09-22T12:32:06.7773645+00:00",
"Due": "2026-09-22T12:32:06.7773645+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "5a4a35c7-1ed0-4098-b667-b0e2b8f9e6e3",
"Type": 0,
"ResourceId": "82c6ffcb-218e-4fa9-bf36-7675712097b4",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "e2660186-4804-4873-943c-08d0ab27218a",
"Start": "2026-09-22T12:32:06.7773645+00:00",
"Due": "2026-09-22T12:32:06.7773645+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "e2660186-4804-4873-943c-08d0ab27218a",
"Start": "2026-09-22T12:32:06.7773645+00:00",
"Due": "2026-09-22T12:32:06.7773645+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f4c281f9-29d6-4306-8d31-b93c7b908f46",
"WorkTypeParentId": "de86c6d2-4ef8-40ad-8eab-d04d3429d76b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ce6e4d6d-6432-4464-b174-089a8a5637c8",
"UPN": "b509078c-c985-4fb8-8471-926ae2874cf4",
"PostDate": "2026-09-22T12:32:06.7773645+00:00",
"Comment": "sample string 4",
"CC": [
"93934d5b-1630-4002-84f6-bdc0f162e7f5",
"87a7665b-b5f5-4c5a-ac4c-8514288eac4a"
],
"Users": [
"4fb56c67-4fdc-4e5b-87b3-da95152bcd42",
"b27df949-b44a-4167-979f-a96d4b20dedd"
]
},
{
"Id": "ce6e4d6d-6432-4464-b174-089a8a5637c8",
"UPN": "b509078c-c985-4fb8-8471-926ae2874cf4",
"PostDate": "2026-09-22T12:32:06.7773645+00:00",
"Comment": "sample string 4",
"CC": [
"93934d5b-1630-4002-84f6-bdc0f162e7f5",
"87a7665b-b5f5-4c5a-ac4c-8514288eac4a"
],
"Users": [
"4fb56c67-4fdc-4e5b-87b3-da95152bcd42",
"b27df949-b44a-4167-979f-a96d4b20dedd"
]
}
],
"StartDate": "2026-09-22T12:32:06.7773645+00:00",
"DueDate": "2026-09-22T12:32:06.7773645+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"05472f18-86ab-4623-8219-930a4e153374": "54b3d894-96ea-49dc-a8f7-1a88812af856",
"0f43e397-f0d3-424b-a67d-4c1fbe876c5e": "a4e5ba34-f952-4f93-b11f-422a3ebc65c1"
},
"HasUpdates": true,
"Modified": "2026-09-22T12:32:06.7773645+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-22T12:32:06.7773645+00:00"
},
"LastComment": "2026-09-22T12:32:06.7773645+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7d520b48-b51d-42ef-9ec0-0790f5090bae",
"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": "d0ca5184-3a7e-4ac9-9bc1-af56314f6044",
"id": "18db893b-cdd3-40cf-9d97-0a4609d8e8c3",
"ConfigId": "c78b02fb-301a-4dd3-86f0-088ca79651a3"
}