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": "587ed0d1-cc0f-4c1a-bc71-18081c25e4c2",
"ParentTaskId": "f6e8d92e-ee22-4ec9-9407-113815704d2f",
"Integration": {
"IntegrationId": "5920587a-4a18-4094-81ac-1134e964645e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"43e9bebb-6172-4334-9835-5c6ae43aa3f8": 2.0,
"d7094873-5608-456d-980e-04ed27405ce8": 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": "26ff53c7-e063-4413-8c71-699c77d65b33",
"Name": "sample string 1",
"Created": "2026-10-16T05:07:58.9541723+00:00",
"Modified": "2026-10-16T05:07:58.9541723+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3ea4b0d7-f5b2-41cf-931a-870906e13d28",
"8e4dbe3e-5190-480d-96d7-6b800b372334"
],
"NonLaborAssignments": [
{
"Id": "3ed7ff34-611e-4680-ba9e-c68e70322b9b",
"ResourceId": "ab4bce75-0cd5-4f9b-9779-48b982429b7f",
"Quantity": 3.0
},
{
"Id": "3ed7ff34-611e-4680-ba9e-c68e70322b9b",
"ResourceId": "ab4bce75-0cd5-4f9b-9779-48b982429b7f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "928fba70-4625-4c37-a322-c88cd203167e",
"Type": 0,
"ResourceId": "4d4564b1-ac8b-4e05-96bd-b4efabaccd74",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "46fb4ac3-cd7c-4a65-ad6b-9439131e649e",
"Start": "2026-10-16T05:07:58.9541723+00:00",
"Due": "2026-10-16T05:07:58.9541723+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "46fb4ac3-cd7c-4a65-ad6b-9439131e649e",
"Start": "2026-10-16T05:07:58.9541723+00:00",
"Due": "2026-10-16T05:07:58.9541723+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "928fba70-4625-4c37-a322-c88cd203167e",
"Type": 0,
"ResourceId": "4d4564b1-ac8b-4e05-96bd-b4efabaccd74",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "46fb4ac3-cd7c-4a65-ad6b-9439131e649e",
"Start": "2026-10-16T05:07:58.9541723+00:00",
"Due": "2026-10-16T05:07:58.9541723+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "46fb4ac3-cd7c-4a65-ad6b-9439131e649e",
"Start": "2026-10-16T05:07:58.9541723+00:00",
"Due": "2026-10-16T05:07:58.9541723+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "19f50898-2bda-42df-8b21-06705df9c20e",
"WorkTypeParentId": "68ee2ee0-7eb5-4fe8-86fe-197048bb6f23",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "0f08834f-0811-489e-847e-2360c88a91de",
"UPN": "5e4006cd-0d15-4943-8813-248c27a4a8cc",
"PostDate": "2026-10-16T05:07:58.9541723+00:00",
"Comment": "sample string 4",
"CC": [
"aa49fb93-667b-439a-a1bf-f5a4a60f25ae",
"a77b5302-fadf-4cf5-8435-f98191893d50"
],
"Users": [
"181d0fd7-fcbf-4cf6-b4da-d273cdfc8013",
"0b762eb2-df94-446e-bd76-13bfd568b8b2"
]
},
{
"Id": "0f08834f-0811-489e-847e-2360c88a91de",
"UPN": "5e4006cd-0d15-4943-8813-248c27a4a8cc",
"PostDate": "2026-10-16T05:07:58.9541723+00:00",
"Comment": "sample string 4",
"CC": [
"aa49fb93-667b-439a-a1bf-f5a4a60f25ae",
"a77b5302-fadf-4cf5-8435-f98191893d50"
],
"Users": [
"181d0fd7-fcbf-4cf6-b4da-d273cdfc8013",
"0b762eb2-df94-446e-bd76-13bfd568b8b2"
]
}
],
"StartDate": "2026-10-16T05:07:58.9541723+00:00",
"DueDate": "2026-10-16T05:07:58.9541723+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3bae9039-8cca-4f8b-82e2-4e0c7ecaba33": "c89306a5-f6c3-4a0d-b457-73a33f427427",
"a2319516-2d0d-46ff-a89b-e5f2f31fbea2": "fb7797ae-3f97-4a42-9f07-9665ca464257"
},
"HasUpdates": true,
"Modified": "2026-10-16T05:07:58.9541723+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-16T05:07:58.9541723+00:00"
},
"LastComment": "2026-10-16T05:07:58.9541723+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1c27caa2-c55a-41d6-991b-5abef65f73e6",
"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": "da5c8e3b-a9c0-4e99-8e54-8fa91679525c",
"id": "0e6ee00b-fd3d-4e25-ab5d-ccec2af00143",
"ConfigId": "b0cd58c2-5235-48cb-b6d8-73300e3e1e49"
}