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": "69849974-533d-4584-a31a-c4c059ba9461",
"ParentTaskId": "e1b8c387-5035-4fbb-8b69-1a1964ad1fca",
"Integration": {
"IntegrationId": "3f73319e-9e47-4440-9e65-7e0a1f543364",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3653df83-3e39-4089-870a-736112b97c71": 2.0,
"3688a896-a5bf-4d5e-9b38-b5f1df8de51b": 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": "fdf8f69b-44ab-4030-a131-d6a3e3c8ccff",
"Name": "sample string 1",
"Created": "2026-08-29T14:36:36.715041+00:00",
"Modified": "2026-08-29T14:36:36.715041+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"20e1d926-3f7f-444f-bb21-c5d87bba6752",
"07d142fe-377e-4adc-aa85-5c1b5280f08b"
],
"NonLaborAssignments": [
{
"Id": "415df786-9e88-4bd2-aa45-1f5c95fc6ee8",
"ResourceId": "9f45d864-9516-460d-98c9-9be1e0053c45",
"Quantity": 3.0
},
{
"Id": "415df786-9e88-4bd2-aa45-1f5c95fc6ee8",
"ResourceId": "9f45d864-9516-460d-98c9-9be1e0053c45",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "cad8a829-e67f-40db-9d81-5f461f572222",
"Type": 0,
"ResourceId": "17358ad3-5c9c-4cbd-8546-5b9632c435c5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2098e9b0-c030-4b9d-a4f6-ec268d29026b",
"Start": "2026-08-29T14:36:36.715041+00:00",
"Due": "2026-08-29T14:36:36.715041+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2098e9b0-c030-4b9d-a4f6-ec268d29026b",
"Start": "2026-08-29T14:36:36.715041+00:00",
"Due": "2026-08-29T14:36:36.715041+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "cad8a829-e67f-40db-9d81-5f461f572222",
"Type": 0,
"ResourceId": "17358ad3-5c9c-4cbd-8546-5b9632c435c5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2098e9b0-c030-4b9d-a4f6-ec268d29026b",
"Start": "2026-08-29T14:36:36.715041+00:00",
"Due": "2026-08-29T14:36:36.715041+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2098e9b0-c030-4b9d-a4f6-ec268d29026b",
"Start": "2026-08-29T14:36:36.715041+00:00",
"Due": "2026-08-29T14:36:36.715041+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "1cd1be27-24cc-4ba3-92b8-716e6b13b61b",
"WorkTypeParentId": "f1d722e7-675f-49ab-b3c2-11e5262b61be",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9237463c-f924-4f20-ab19-6cad96731943",
"UPN": "30ae1efe-11bd-45ce-903f-bbb4a3f4711e",
"PostDate": "2026-08-29T14:36:36.715041+00:00",
"Comment": "sample string 4",
"CC": [
"333e43ea-3f76-4944-a0bf-fe5bdfa4b343",
"0486ca3e-e882-40cf-8dbc-6202c1e37db4"
],
"Users": [
"533691f3-08e3-479a-a5b9-11965cbb2fbc",
"3d3086c4-8d2e-4fe4-84a0-a0e3902c208a"
]
},
{
"Id": "9237463c-f924-4f20-ab19-6cad96731943",
"UPN": "30ae1efe-11bd-45ce-903f-bbb4a3f4711e",
"PostDate": "2026-08-29T14:36:36.715041+00:00",
"Comment": "sample string 4",
"CC": [
"333e43ea-3f76-4944-a0bf-fe5bdfa4b343",
"0486ca3e-e882-40cf-8dbc-6202c1e37db4"
],
"Users": [
"533691f3-08e3-479a-a5b9-11965cbb2fbc",
"3d3086c4-8d2e-4fe4-84a0-a0e3902c208a"
]
}
],
"StartDate": "2026-08-29T14:36:36.715041+00:00",
"DueDate": "2026-08-29T14:36:36.715041+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"525c04fc-a089-4be2-822f-483a5110ae85": "94f59b83-abd0-4211-994a-c56972b214d2",
"ab4ef052-033a-4bc1-b457-6e0df7bd9043": "d8af7c3e-57e1-4f72-bd1f-b63abbebd430"
},
"HasUpdates": true,
"Modified": "2026-08-29T14:36:36.715041+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-08-29T14:36:36.715041+00:00"
},
"LastComment": "2026-08-29T14:36:36.715041+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cb456a12-c890-479c-9812-fcc74913455f",
"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": "962f0f35-dfe5-4028-8596-423ff142aa59",
"id": "2613349a-76b6-41aa-9919-0c6d5bb16d55",
"ConfigId": "69c86e1b-f677-48a5-ac6a-e48a109ac7d4"
}