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": "29f2f2a0-7c84-4bb0-a8ba-d1c35d1d9de8",
"ParentTaskId": "32dfc244-b515-4c3a-911c-ebef0728d4a5",
"Integration": {
"IntegrationId": "7be378a1-79b9-4266-88d4-94379e6765f5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"11e725c5-90b6-4fe0-8ac6-fd19aa5b3960": 2.0,
"c976582f-bde6-4f65-b897-70d0aaac596a": 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": "2eaa9ffc-4d71-4fa4-bbf9-01eeb0c597ae",
"Name": "sample string 1",
"Created": "2026-10-29T06:29:57.805538+00:00",
"Modified": "2026-10-29T06:29:57.805538+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7ca167e6-4b15-47c2-9654-f19b09b98a85",
"e46f67b1-0429-4d9b-a9d8-9f86e2fb40bb"
],
"NonLaborAssignments": [
{
"Id": "b0afae04-3660-484b-b567-c6d3377a5fc6",
"ResourceId": "fc142ebd-9c53-44e1-abc5-a0f5f876ec34",
"Quantity": 3.0
},
{
"Id": "b0afae04-3660-484b-b567-c6d3377a5fc6",
"ResourceId": "fc142ebd-9c53-44e1-abc5-a0f5f876ec34",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9a449eb7-8bd2-4177-bfc6-e6eeac76c4b8",
"Type": 0,
"ResourceId": "d5054804-a051-45cf-926e-a697922960bd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b211f684-c019-4c3d-ac14-ff4fadebba4f",
"Start": "2026-10-29T06:29:57.805538+00:00",
"Due": "2026-10-29T06:29:57.805538+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b211f684-c019-4c3d-ac14-ff4fadebba4f",
"Start": "2026-10-29T06:29:57.805538+00:00",
"Due": "2026-10-29T06:29:57.805538+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "9a449eb7-8bd2-4177-bfc6-e6eeac76c4b8",
"Type": 0,
"ResourceId": "d5054804-a051-45cf-926e-a697922960bd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b211f684-c019-4c3d-ac14-ff4fadebba4f",
"Start": "2026-10-29T06:29:57.805538+00:00",
"Due": "2026-10-29T06:29:57.805538+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b211f684-c019-4c3d-ac14-ff4fadebba4f",
"Start": "2026-10-29T06:29:57.805538+00:00",
"Due": "2026-10-29T06:29:57.805538+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "197c37f7-a4a4-4b96-bc98-d8950e4315d4",
"WorkTypeParentId": "ae3b4ee2-f47e-448d-b8bf-f5ca7dcb3fce",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e3766c58-6dce-46cc-881e-7a5d89471c73",
"UPN": "af3d1823-fa68-48f0-8318-da6ddc5a7aa5",
"PostDate": "2026-10-29T06:29:57.805538+00:00",
"Comment": "sample string 4",
"CC": [
"89555943-1ced-4777-bb48-556fb2f09876",
"c18901aa-fcd4-4926-8922-7f58bbf4dc79"
],
"Users": [
"e0240b58-e6ba-4810-a146-1746bfe14493",
"7b75d588-d833-4ce7-ad12-d938857e7525"
]
},
{
"Id": "e3766c58-6dce-46cc-881e-7a5d89471c73",
"UPN": "af3d1823-fa68-48f0-8318-da6ddc5a7aa5",
"PostDate": "2026-10-29T06:29:57.805538+00:00",
"Comment": "sample string 4",
"CC": [
"89555943-1ced-4777-bb48-556fb2f09876",
"c18901aa-fcd4-4926-8922-7f58bbf4dc79"
],
"Users": [
"e0240b58-e6ba-4810-a146-1746bfe14493",
"7b75d588-d833-4ce7-ad12-d938857e7525"
]
}
],
"StartDate": "2026-10-29T06:29:57.805538+00:00",
"DueDate": "2026-10-29T06:29:57.805538+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d05199d2-aac5-42f0-84c0-db33a57655f7": "1b0c7592-06c8-441a-b64b-1196a8b35f4b",
"f7569699-7a8e-4d92-a3e6-21f998777805": "81ec183d-5ffb-44cd-a35c-c137e8b9bcd7"
},
"HasUpdates": true,
"Modified": "2026-10-29T06:29:57.805538+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-29T06:29:57.805538+00:00"
},
"LastComment": "2026-10-29T06:29:57.805538+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "be882fa6-c20c-43c1-80e8-06f81a2d5e3a",
"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": "4005262b-05d0-455d-8675-7d872904c163",
"id": "e28d7e6a-c807-4e3b-936c-ece3c39601de",
"ConfigId": "37e83651-bd5c-4386-8640-ac54c8254771"
}