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": "f1520c65-ef6b-4758-a0da-0caf52042f43",
"ParentTaskId": "5e6494c4-7fe8-4848-a5d4-5470e8b71c61",
"Integration": {
"IntegrationId": "09e2b745-87b0-4299-a668-2f5cb4c47bf3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9160dc1b-d88e-407d-8209-ea330a70c2b3": 2.0,
"4487686c-3db0-4ead-a74e-5371a4c45768": 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": "47cc7859-5fd6-418a-9b47-71d9bcead9af",
"Name": "sample string 1",
"Created": "2026-10-14T00:40:13.2291884+00:00",
"Modified": "2026-10-14T00:40:13.2291884+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ed9e958c-eccc-4db4-800c-867b4a77086a",
"20ae7549-08b7-4b41-85b1-3984694a2b33"
],
"NonLaborAssignments": [
{
"Id": "ec79fe9a-1748-400a-b822-bf70f11175f0",
"ResourceId": "5b72660f-c69a-4558-b028-20256b97acf2",
"Quantity": 3.0
},
{
"Id": "ec79fe9a-1748-400a-b822-bf70f11175f0",
"ResourceId": "5b72660f-c69a-4558-b028-20256b97acf2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "aa8e004f-edb8-46c5-a170-d3aa93a4c5b3",
"Type": 0,
"ResourceId": "7b74634d-00dd-4506-a907-c7cc89fe6627",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c8de76e3-e52c-482f-9c43-d0e315c8e4cd",
"Start": "2026-10-14T00:40:13.2291884+00:00",
"Due": "2026-10-14T00:40:13.2291884+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c8de76e3-e52c-482f-9c43-d0e315c8e4cd",
"Start": "2026-10-14T00:40:13.2291884+00:00",
"Due": "2026-10-14T00:40:13.2291884+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "aa8e004f-edb8-46c5-a170-d3aa93a4c5b3",
"Type": 0,
"ResourceId": "7b74634d-00dd-4506-a907-c7cc89fe6627",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c8de76e3-e52c-482f-9c43-d0e315c8e4cd",
"Start": "2026-10-14T00:40:13.2291884+00:00",
"Due": "2026-10-14T00:40:13.2291884+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c8de76e3-e52c-482f-9c43-d0e315c8e4cd",
"Start": "2026-10-14T00:40:13.2291884+00:00",
"Due": "2026-10-14T00:40:13.2291884+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "912c19cb-0479-4995-b02d-797ef99fdcdf",
"WorkTypeParentId": "ee66c2f9-578e-4932-bbdf-3f423de5ae8c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2ef70b42-9f46-4c41-91ce-b27d5d66256d",
"UPN": "7075c033-a87c-4d99-9bc7-d53ac1a6818d",
"PostDate": "2026-10-14T00:40:13.2291884+00:00",
"Comment": "sample string 4",
"CC": [
"edbf125e-9b74-453a-89e9-b9ebb2ea903f",
"6d7454e5-2018-4ab2-abd0-c25d4ccf706f"
],
"Users": [
"bcf319fb-1791-453f-a4e9-4c9cb1893f99",
"a0bbf03a-1e63-4dac-aff3-6bb748bebe54"
]
},
{
"Id": "2ef70b42-9f46-4c41-91ce-b27d5d66256d",
"UPN": "7075c033-a87c-4d99-9bc7-d53ac1a6818d",
"PostDate": "2026-10-14T00:40:13.2291884+00:00",
"Comment": "sample string 4",
"CC": [
"edbf125e-9b74-453a-89e9-b9ebb2ea903f",
"6d7454e5-2018-4ab2-abd0-c25d4ccf706f"
],
"Users": [
"bcf319fb-1791-453f-a4e9-4c9cb1893f99",
"a0bbf03a-1e63-4dac-aff3-6bb748bebe54"
]
}
],
"StartDate": "2026-10-14T00:40:13.2291884+00:00",
"DueDate": "2026-10-14T00:40:13.2291884+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1d889ace-1a38-4900-b75b-5c06d785e400": "b8db2c0a-24ce-47f7-8781-b900d1fb64c4",
"9e62a1a1-21d4-441d-9740-b33400b73b6b": "abaa8e68-2c7a-4f64-b36e-8329093e255f"
},
"HasUpdates": true,
"Modified": "2026-10-14T00:40:13.2291884+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-14T00:40:13.2291884+00:00"
},
"LastComment": "2026-10-14T00:40:13.2291884+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "27591667-1a40-416a-81ca-bb0e961f86f5",
"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": "676f2a50-9ec7-4297-9700-a3b02f420dc5",
"id": "7ba411cb-fb04-4b4c-bcee-59bf1ba1eeda",
"ConfigId": "372e9902-5e00-4342-bb01-e4f8f52da602"
}