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": "dd21441f-ad6c-4b79-9f71-d46dadb8b26f",
"ParentTaskId": "d5f3d5d1-86b6-49d5-bbf4-966a4b4a455a",
"Integration": {
"IntegrationId": "940a4ad2-5018-411f-9c73-16149d3330f9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e1309b93-051a-43a2-8acc-73464a186e77": 2.0,
"e3bda894-d27a-4822-9f6b-9ca12e245a34": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "be65abf9-ddf6-45b0-bca1-74532f81be8b",
"Name": "sample string 1",
"Created": "2026-03-27T09:11:41.9485831+00:00",
"Modified": "2026-03-27T09:11:41.9485831+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4dead47a-04ca-4cb4-b1b7-140fc6fadddb",
"1db4d88d-2456-4836-a766-805307fbc969"
],
"NonLaborAssignments": [
{
"Id": "c068ed0f-195a-451e-afb2-8c4a4829183c",
"ResourceId": "4262e67c-4277-4623-8520-b39e331533cf",
"Quantity": 3.0
},
{
"Id": "c068ed0f-195a-451e-afb2-8c4a4829183c",
"ResourceId": "4262e67c-4277-4623-8520-b39e331533cf",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "fb463524-f0e5-4136-8b20-1939b596c808",
"Type": 0,
"ResourceId": "eb171a21-94aa-4443-89a8-049d3d4e1bde",
"Units": 3.0
},
{
"Id": "fb463524-f0e5-4136-8b20-1939b596c808",
"Type": 0,
"ResourceId": "eb171a21-94aa-4443-89a8-049d3d4e1bde",
"Units": 3.0
}
],
"ParentId": "d47f5127-f80a-4a5b-987e-bf6e8542c420",
"WorkTypeParentId": "1be46c12-adf4-4451-ba6f-ab283bfea91b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a1fea8fe-6721-433f-aeb3-b03ed8d2185f",
"UPN": "2a019f6c-44c4-48d5-8b9f-ac374bf663f8",
"PostDate": "2026-03-27T09:11:41.9485831+00:00",
"Comment": "sample string 4",
"CC": [
"b6adfa78-ff07-4574-a77f-c28a9e569253",
"b0bd9bd1-e57a-4b5d-b1e3-b77162fce290"
],
"Users": [
"ff91694a-be7f-4c75-bbc4-a11dcec221d2",
"89c03f61-d400-4bb9-a42e-bf4cad3fdc9e"
]
},
{
"Id": "a1fea8fe-6721-433f-aeb3-b03ed8d2185f",
"UPN": "2a019f6c-44c4-48d5-8b9f-ac374bf663f8",
"PostDate": "2026-03-27T09:11:41.9485831+00:00",
"Comment": "sample string 4",
"CC": [
"b6adfa78-ff07-4574-a77f-c28a9e569253",
"b0bd9bd1-e57a-4b5d-b1e3-b77162fce290"
],
"Users": [
"ff91694a-be7f-4c75-bbc4-a11dcec221d2",
"89c03f61-d400-4bb9-a42e-bf4cad3fdc9e"
]
}
],
"StartDate": "2026-03-27T09:11:41.9485831+00:00",
"DueDate": "2026-03-27T09:11:41.9485831+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"207d1ae0-bbaa-4d09-b88a-1a39d5628334": "ef2861ad-bec8-4418-a91c-ffb011f41a8b",
"1512e348-4804-48a9-90ad-67b9c46291b7": "59c64262-6352-431f-803a-81e965c4f705"
},
"HasUpdates": true,
"Modified": "2026-03-27T09:11:41.9485831+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-03-27T09:11:41.9485831+00:00"
},
"LastComment": "2026-03-27T09:11:41.9485831+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9917f9c2-62f5-4bd4-9262-426a63856380",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "7479f31e-5c3a-43cd-a78e-a2d23e5f477b",
"id": "aef6c90b-9667-4cd6-9238-e5f653154d8e",
"ConfigId": "f717863d-89b9-403a-b253-6b0fba110539"
}