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": "da67937b-b4eb-4b0b-9fde-f5e04d398ec7",
"ParentTaskId": "230ffca2-2241-43af-9575-337704ecc7b5",
"Integration": {
"IntegrationId": "6975f436-c0f0-4fa4-9228-b5707d460885",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ee5fa434-d961-4c18-8412-bf2d2dd8825b": 2.0,
"62b98d54-da8b-402a-b322-6cd3b37a15ce": 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": "c00a587c-0583-4ea9-9b1f-8f94dde5bd14",
"Name": "sample string 1",
"Created": "2026-10-01T20:16:53.0744442+00:00",
"Modified": "2026-10-01T20:16:53.0744442+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4041cd2b-fa3e-4e6d-a99c-fd9af77d1550",
"09d8687d-5898-410c-ac69-d13f714aaa52"
],
"NonLaborAssignments": [
{
"Id": "87bcd1f1-f675-48fb-8b15-516cb29e287d",
"ResourceId": "6cc5a41e-6208-4197-bf97-069bbd08052c",
"Quantity": 3.0
},
{
"Id": "87bcd1f1-f675-48fb-8b15-516cb29e287d",
"ResourceId": "6cc5a41e-6208-4197-bf97-069bbd08052c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "86963cf9-1b58-4250-9544-838d7368707c",
"Type": 0,
"ResourceId": "0dd6c64c-8402-47b9-a73f-ced35cdcb5c1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "07ac8087-7a61-4d4f-80c6-f76b3c1ffb53",
"Start": "2026-10-01T20:16:53.0744442+00:00",
"Due": "2026-10-01T20:16:53.0744442+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "07ac8087-7a61-4d4f-80c6-f76b3c1ffb53",
"Start": "2026-10-01T20:16:53.0744442+00:00",
"Due": "2026-10-01T20:16:53.0744442+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "86963cf9-1b58-4250-9544-838d7368707c",
"Type": 0,
"ResourceId": "0dd6c64c-8402-47b9-a73f-ced35cdcb5c1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "07ac8087-7a61-4d4f-80c6-f76b3c1ffb53",
"Start": "2026-10-01T20:16:53.0744442+00:00",
"Due": "2026-10-01T20:16:53.0744442+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "07ac8087-7a61-4d4f-80c6-f76b3c1ffb53",
"Start": "2026-10-01T20:16:53.0744442+00:00",
"Due": "2026-10-01T20:16:53.0744442+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e44f6bdc-3f54-4a84-bb2e-0b29ac1f24bf",
"WorkTypeParentId": "ce41334c-0587-4734-87d6-fd38afa39e7b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3245a28d-a344-439a-8585-0ed1e3813e3f",
"UPN": "d679bb57-ee3c-4e79-aa2f-54fee35f826e",
"PostDate": "2026-10-01T20:16:53.0744442+00:00",
"Comment": "sample string 4",
"CC": [
"5ac658a2-e7ed-4821-8368-03a7e16f8344",
"b9a8f6ae-cece-473f-b0db-f38869a0cc78"
],
"Users": [
"ae72aa1e-333c-4f8d-9517-5fec6963d728",
"cd510733-98ab-4d55-8c74-dba1c931af6f"
]
},
{
"Id": "3245a28d-a344-439a-8585-0ed1e3813e3f",
"UPN": "d679bb57-ee3c-4e79-aa2f-54fee35f826e",
"PostDate": "2026-10-01T20:16:53.0744442+00:00",
"Comment": "sample string 4",
"CC": [
"5ac658a2-e7ed-4821-8368-03a7e16f8344",
"b9a8f6ae-cece-473f-b0db-f38869a0cc78"
],
"Users": [
"ae72aa1e-333c-4f8d-9517-5fec6963d728",
"cd510733-98ab-4d55-8c74-dba1c931af6f"
]
}
],
"StartDate": "2026-10-01T20:16:53.0744442+00:00",
"DueDate": "2026-10-01T20:16:53.0744442+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cc24b1c9-59f0-4905-aa9a-8fb2c04e72ed": "906c7bbd-26b2-46c8-8879-beaefdd3a6cb",
"91e2222a-3bff-41c3-a791-4b899ae04733": "569a24fb-fda9-4c02-bb93-8b8b600bea3a"
},
"HasUpdates": true,
"Modified": "2026-10-01T20:16:53.0744442+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-01T20:16:53.0744442+00:00"
},
"LastComment": "2026-10-01T20:16:53.0744442+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "01921590-740b-457c-b554-22fa822033e0",
"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": "3126da44-7d20-4176-afaf-4ff7869595d5",
"id": "0b3de80a-9f8c-4541-a020-81b903f7d1cc",
"ConfigId": "4e686273-bab5-41d3-9f38-46ac9ca3679d"
}