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": "9fddf03c-020d-470e-ad79-2f94434f21aa",
"ParentTaskId": "a057b5c8-636a-4f8a-b145-fc67136b35e4",
"Integration": {
"IntegrationId": "e16f0129-894f-4c41-9b59-773cc0bfc94e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"72be6745-f27e-4a95-bac1-04c72a7f8b08": 2.0,
"9b7b2dd1-78d9-4a3a-a187-6f864d9431dd": 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": "1f89c115-77a6-4a37-a271-660df5959215",
"Name": "sample string 1",
"Created": "2026-09-27T23:45:03.6507627+00:00",
"Modified": "2026-09-27T23:45:03.6507627+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ef7bb4cf-854b-422b-a53a-ddce1c354a02",
"9ba50bf6-0407-46f7-98bd-14619967ecb0"
],
"NonLaborAssignments": [
{
"Id": "9145005e-9585-4d4f-88cf-558ad36d3e98",
"ResourceId": "70bbbcd4-b525-414f-92e1-93d6259cf4e2",
"Quantity": 3.0
},
{
"Id": "9145005e-9585-4d4f-88cf-558ad36d3e98",
"ResourceId": "70bbbcd4-b525-414f-92e1-93d6259cf4e2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "49f05d71-0885-488e-b126-384fbe46cb0f",
"Type": 0,
"ResourceId": "bcab246f-bb0e-4cef-ad2d-c7f46320d18c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a4dc5e96-0486-4052-8d06-a276216d5c41",
"Start": "2026-09-27T23:45:03.6507627+00:00",
"Due": "2026-09-27T23:45:03.6507627+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a4dc5e96-0486-4052-8d06-a276216d5c41",
"Start": "2026-09-27T23:45:03.6507627+00:00",
"Due": "2026-09-27T23:45:03.6507627+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "49f05d71-0885-488e-b126-384fbe46cb0f",
"Type": 0,
"ResourceId": "bcab246f-bb0e-4cef-ad2d-c7f46320d18c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a4dc5e96-0486-4052-8d06-a276216d5c41",
"Start": "2026-09-27T23:45:03.6507627+00:00",
"Due": "2026-09-27T23:45:03.6507627+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a4dc5e96-0486-4052-8d06-a276216d5c41",
"Start": "2026-09-27T23:45:03.6507627+00:00",
"Due": "2026-09-27T23:45:03.6507627+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "559db3c7-d8e5-4193-8943-29aa60d18856",
"WorkTypeParentId": "b8075475-fd1f-4602-be3f-9a4da7f2f3a8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f8ecdd5d-06d3-42fb-a658-3e04c5810e14",
"UPN": "c74baa9a-17c4-4adf-a751-68d978d666a0",
"PostDate": "2026-09-27T23:45:03.6507627+00:00",
"Comment": "sample string 4",
"CC": [
"9bcd1daa-4ba4-4625-98eb-3e4dfd0f5624",
"8b9e1c4d-f259-4a7c-99b8-b188c50740cd"
],
"Users": [
"0e2eac8c-b325-4919-975a-5b34bdfab61f",
"26582632-d523-4a36-b103-e6389583b7a5"
]
},
{
"Id": "f8ecdd5d-06d3-42fb-a658-3e04c5810e14",
"UPN": "c74baa9a-17c4-4adf-a751-68d978d666a0",
"PostDate": "2026-09-27T23:45:03.6507627+00:00",
"Comment": "sample string 4",
"CC": [
"9bcd1daa-4ba4-4625-98eb-3e4dfd0f5624",
"8b9e1c4d-f259-4a7c-99b8-b188c50740cd"
],
"Users": [
"0e2eac8c-b325-4919-975a-5b34bdfab61f",
"26582632-d523-4a36-b103-e6389583b7a5"
]
}
],
"StartDate": "2026-09-27T23:45:03.6507627+00:00",
"DueDate": "2026-09-27T23:45:03.6507627+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"86add986-f2b5-48f0-9aa9-9ef15d6379d3": "fccbb19a-ffb8-453f-b4e0-891d125b69d0",
"d71ccf39-44c9-465e-9d45-7e0e36ba1913": "97b49bcc-baba-486d-a1ac-cc28cebbfa02"
},
"HasUpdates": true,
"Modified": "2026-09-27T23:45:03.6507627+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-27T23:45:03.6507627+00:00"
},
"LastComment": "2026-09-27T23:45:03.6507627+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b325375d-1c80-4863-8d8a-421f1fb4b8cc",
"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": "89e771ea-794d-4bc8-8fa3-92ea6d6eb403",
"id": "19e9724d-f14e-44a4-ad06-a404e8c8041f",
"ConfigId": "d3146a7d-0b81-4ebf-827c-6e44773ce6a4"
}