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": "c25a577c-eccf-45c0-a0d3-c95a51c0d2aa",
"ParentTaskId": "d86c3bd9-7c5d-486d-b25f-d3e33c9943fb",
"Integration": {
"IntegrationId": "16dfe149-eb2a-46c3-8196-8560799a5b90",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"769af8e9-2803-4026-b38a-f602f3adb637": 2.0,
"d9fbffd0-c742-43ab-990f-6ed1ba5188ca": 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": "8f04969e-c7ee-4d26-98b9-d99980201cea",
"Name": "sample string 1",
"Created": "2026-09-07T05:33:32.8347337+00:00",
"Modified": "2026-09-07T05:33:32.8347337+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8369956b-590b-46ec-9d4b-e4d77ff6004f",
"9e0bd710-d1ac-4cfa-a4ae-f9a97731c2cf"
],
"NonLaborAssignments": [
{
"Id": "728556b6-3de4-4ffe-945b-f1c5d5fce87d",
"ResourceId": "1b812ec8-f4f2-4bd6-9e83-2fb9ea452b8c",
"Quantity": 3.0
},
{
"Id": "728556b6-3de4-4ffe-945b-f1c5d5fce87d",
"ResourceId": "1b812ec8-f4f2-4bd6-9e83-2fb9ea452b8c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d799c90f-eebc-445e-b699-0e1ded9760e9",
"Type": 0,
"ResourceId": "2be03cd3-5c25-4914-88e1-a0ba2aaf844b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "07a35fcc-0a05-41bb-ab4b-760c6423bcab",
"Start": "2026-09-07T05:33:32.8347337+00:00",
"Due": "2026-09-07T05:33:32.8347337+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "07a35fcc-0a05-41bb-ab4b-760c6423bcab",
"Start": "2026-09-07T05:33:32.8347337+00:00",
"Due": "2026-09-07T05:33:32.8347337+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "d799c90f-eebc-445e-b699-0e1ded9760e9",
"Type": 0,
"ResourceId": "2be03cd3-5c25-4914-88e1-a0ba2aaf844b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "07a35fcc-0a05-41bb-ab4b-760c6423bcab",
"Start": "2026-09-07T05:33:32.8347337+00:00",
"Due": "2026-09-07T05:33:32.8347337+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "07a35fcc-0a05-41bb-ab4b-760c6423bcab",
"Start": "2026-09-07T05:33:32.8347337+00:00",
"Due": "2026-09-07T05:33:32.8347337+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "cf2aab05-0b66-499f-945d-a65a6c7340c7",
"WorkTypeParentId": "29b0324c-b76b-4b94-91a2-c405c2a62338",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e7212a17-b27b-4e71-87f7-f0d1ed9043cb",
"UPN": "6fddec5e-0f47-4758-9612-552f36e0229f",
"PostDate": "2026-09-07T05:33:32.8347337+00:00",
"Comment": "sample string 4",
"CC": [
"f3ef7d9f-33ff-47b5-bec5-a7ead81ea2a1",
"8713e6f8-55e6-4740-94f9-4d0119520a0e"
],
"Users": [
"74ec0cdb-12f4-4c32-84e0-ea7b351503c7",
"d955c76d-fe5a-4cf8-9045-9b09382481a8"
]
},
{
"Id": "e7212a17-b27b-4e71-87f7-f0d1ed9043cb",
"UPN": "6fddec5e-0f47-4758-9612-552f36e0229f",
"PostDate": "2026-09-07T05:33:32.8347337+00:00",
"Comment": "sample string 4",
"CC": [
"f3ef7d9f-33ff-47b5-bec5-a7ead81ea2a1",
"8713e6f8-55e6-4740-94f9-4d0119520a0e"
],
"Users": [
"74ec0cdb-12f4-4c32-84e0-ea7b351503c7",
"d955c76d-fe5a-4cf8-9045-9b09382481a8"
]
}
],
"StartDate": "2026-09-07T05:33:32.8347337+00:00",
"DueDate": "2026-09-07T05:33:32.8347337+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1442e6fc-cc3f-4621-95eb-a8131a94955b": "dfeece05-9c39-4bdd-b3f7-34e1501b06a5",
"6d2f10fc-de7e-4079-9607-d1d153cbf87e": "95dd3f4a-998e-46ea-a657-5915ab53d205"
},
"HasUpdates": true,
"Modified": "2026-09-07T05:33:32.8347337+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-09-07T05:33:32.8347337+00:00"
},
"LastComment": "2026-09-07T05:33:32.8347337+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f1a88529-c9b7-4c4a-a201-b1d169d92287",
"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": "0b056756-52d7-4736-b813-0927e3b6db84",
"id": "60f87291-9897-460f-b241-0d661d44995b",
"ConfigId": "37a194aa-b9a1-4a29-a006-d756e7bd03dc"
}