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": "ec0794e0-f91d-4085-b0bb-d15ad7030a10",
"ParentTaskId": "5d0f2cbb-ffa0-4a25-a70e-7cb5a8c4bb3a",
"Integration": {
"IntegrationId": "8c436364-14f6-4427-acd6-48c5d7038254",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d2aa63e7-d71e-44e4-97b7-cca4fb61e711": 2.0,
"4b9da53b-c4bf-4a72-80eb-1a682c20ed3a": 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": "8b1934f9-da91-4a2c-9694-e142b862afe2",
"Name": "sample string 1",
"Created": "2026-10-06T04:10:36.5637896+00:00",
"Modified": "2026-10-06T04:10:36.5637896+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"aedd8536-6d56-4ff9-bd71-cc7c942c5ba9",
"732f60a5-2f6f-4bd5-b13e-fd545d2c2ff9"
],
"NonLaborAssignments": [
{
"Id": "edd59194-c45e-48b9-bb25-6860e6a461a3",
"ResourceId": "0a0f5ad4-f32b-42b6-9829-3c434c5894b3",
"Quantity": 3.0
},
{
"Id": "edd59194-c45e-48b9-bb25-6860e6a461a3",
"ResourceId": "0a0f5ad4-f32b-42b6-9829-3c434c5894b3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "cee56660-a562-4374-b1a3-4724c0404e14",
"Type": 0,
"ResourceId": "7b34c235-dd4c-49bb-a14c-e8472ec1ccea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0b33b5ad-2f20-42c1-9bf9-1972c3160581",
"Start": "2026-10-06T04:10:36.5637896+00:00",
"Due": "2026-10-06T04:10:36.5637896+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0b33b5ad-2f20-42c1-9bf9-1972c3160581",
"Start": "2026-10-06T04:10:36.5637896+00:00",
"Due": "2026-10-06T04:10:36.5637896+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "cee56660-a562-4374-b1a3-4724c0404e14",
"Type": 0,
"ResourceId": "7b34c235-dd4c-49bb-a14c-e8472ec1ccea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0b33b5ad-2f20-42c1-9bf9-1972c3160581",
"Start": "2026-10-06T04:10:36.5637896+00:00",
"Due": "2026-10-06T04:10:36.5637896+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0b33b5ad-2f20-42c1-9bf9-1972c3160581",
"Start": "2026-10-06T04:10:36.5637896+00:00",
"Due": "2026-10-06T04:10:36.5637896+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "dde71d78-3963-41d0-b48c-5b1a579ee868",
"WorkTypeParentId": "2a8101e8-d7d6-4338-924a-c6ad24ee77fc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8620b746-c9dd-4b14-958e-0631430c873e",
"UPN": "ab4bee9e-be8f-4746-b570-8d70bf4d5157",
"PostDate": "2026-10-06T04:10:36.5637896+00:00",
"Comment": "sample string 4",
"CC": [
"bd9be310-9ada-44ca-b0f5-d183ac052eec",
"c3663bdd-a222-4504-a927-1eb14a959ee0"
],
"Users": [
"b9fbee51-d72c-4c7a-879d-820938a31314",
"b14e1945-5ad7-407d-9686-3aca5d1fca45"
]
},
{
"Id": "8620b746-c9dd-4b14-958e-0631430c873e",
"UPN": "ab4bee9e-be8f-4746-b570-8d70bf4d5157",
"PostDate": "2026-10-06T04:10:36.5637896+00:00",
"Comment": "sample string 4",
"CC": [
"bd9be310-9ada-44ca-b0f5-d183ac052eec",
"c3663bdd-a222-4504-a927-1eb14a959ee0"
],
"Users": [
"b9fbee51-d72c-4c7a-879d-820938a31314",
"b14e1945-5ad7-407d-9686-3aca5d1fca45"
]
}
],
"StartDate": "2026-10-06T04:10:36.5637896+00:00",
"DueDate": "2026-10-06T04:10:36.5637896+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4bed1c57-b39d-4bcd-9c5c-a608a8663157": "532b2b00-7920-4ff8-854f-8643609f1445",
"4cbb60b5-2260-43a3-9f94-a31761240cfb": "e7fdbaf9-1f78-46f9-9658-3bae448ffc98"
},
"HasUpdates": true,
"Modified": "2026-10-06T04:10:36.5637896+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-06T04:10:36.5637896+00:00"
},
"LastComment": "2026-10-06T04:10:36.5637896+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "269b6917-a1e4-4c5a-afd8-42a8b60737c4",
"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": "2070321d-b4fe-4e87-9b72-9f308939fd7b",
"id": "5410a350-fede-4e85-9c5d-f84e576c7864",
"ConfigId": "8bc3a223-459d-4cdd-881b-4949ca0545f1"
}