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": "8a4fa62f-f3e4-44b7-bb9d-353832c0481a",
"ParentTaskId": "622ab432-d1b6-4298-a286-d941db21f31f",
"Integration": {
"IntegrationId": "7da99413-17a0-4ed3-ba9a-36a25121ea96",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"43f2e5ba-fe63-448b-859a-5049eacc91d4": 2.0,
"4d475507-472e-4760-bac2-cd1789bb13d1": 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": "b0171699-1cb3-44e0-b151-a409dbc8aea2",
"Name": "sample string 1",
"Created": "2026-08-31T05:16:34.5110834+00:00",
"Modified": "2026-08-31T05:16:34.5110834+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f7ac6df1-ce93-4e83-bc8b-c894ea9d3a43",
"5db57a6a-4394-46a4-951e-f30e968af8ef"
],
"NonLaborAssignments": [
{
"Id": "dac3375d-3972-4565-939d-1667dcdb5869",
"ResourceId": "2d24b98e-3920-4212-9149-551c78a458c9",
"Quantity": 3.0
},
{
"Id": "dac3375d-3972-4565-939d-1667dcdb5869",
"ResourceId": "2d24b98e-3920-4212-9149-551c78a458c9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bf33c522-4e11-47ce-b1f4-000ad9838c49",
"Type": 0,
"ResourceId": "2658aa90-db23-480b-ad21-8716187bde16",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f68a43aa-199e-4307-88cb-77f99017bf76",
"Start": "2026-08-31T05:16:34.5110834+00:00",
"Due": "2026-08-31T05:16:34.5110834+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f68a43aa-199e-4307-88cb-77f99017bf76",
"Start": "2026-08-31T05:16:34.5110834+00:00",
"Due": "2026-08-31T05:16:34.5110834+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "bf33c522-4e11-47ce-b1f4-000ad9838c49",
"Type": 0,
"ResourceId": "2658aa90-db23-480b-ad21-8716187bde16",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f68a43aa-199e-4307-88cb-77f99017bf76",
"Start": "2026-08-31T05:16:34.5110834+00:00",
"Due": "2026-08-31T05:16:34.5110834+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f68a43aa-199e-4307-88cb-77f99017bf76",
"Start": "2026-08-31T05:16:34.5110834+00:00",
"Due": "2026-08-31T05:16:34.5110834+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "8c94813b-92a8-4767-8318-e2ffc8689a93",
"WorkTypeParentId": "e38509d5-16d5-4ff4-9be3-110c996f9fe9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ae349279-74c4-4f2c-b712-01314a5047c0",
"UPN": "a5b63fc2-986c-4ece-9659-bf4375c7d523",
"PostDate": "2026-08-31T05:16:34.5110834+00:00",
"Comment": "sample string 4",
"CC": [
"970b2725-ae12-4a31-a878-3619eda75cac",
"c9d847aa-6935-4e16-9c8c-51b09652b030"
],
"Users": [
"4a811614-dd18-4c04-a4d8-5495421539f7",
"443b4be2-483d-4768-b82c-9ea57fd1856e"
]
},
{
"Id": "ae349279-74c4-4f2c-b712-01314a5047c0",
"UPN": "a5b63fc2-986c-4ece-9659-bf4375c7d523",
"PostDate": "2026-08-31T05:16:34.5110834+00:00",
"Comment": "sample string 4",
"CC": [
"970b2725-ae12-4a31-a878-3619eda75cac",
"c9d847aa-6935-4e16-9c8c-51b09652b030"
],
"Users": [
"4a811614-dd18-4c04-a4d8-5495421539f7",
"443b4be2-483d-4768-b82c-9ea57fd1856e"
]
}
],
"StartDate": "2026-08-31T05:16:34.5110834+00:00",
"DueDate": "2026-08-31T05:16:34.5110834+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e3831cdb-4168-40ad-b0aa-f1c2b8c6730e": "4c65c182-946c-45ed-b453-7a5b58ac0759",
"f7dcf0bd-55db-409c-ba0e-0770c2cab2d1": "9615aa6b-b89d-4688-86d9-9a07409c45bb"
},
"HasUpdates": true,
"Modified": "2026-08-31T05:16:34.5110834+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-31T05:16:34.5110834+00:00"
},
"LastComment": "2026-08-31T05:16:34.5110834+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b6b740dd-03d3-4c4c-811f-92f2f592322b",
"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": "d44b86c3-fdc6-4b06-b465-9bf2fc5cd3dc",
"id": "4a2320f2-c3dc-4f71-9cda-da362f4a6408",
"ConfigId": "09348aa6-a3ab-41fb-9bca-387acf60a330"
}