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": "85041756-a73c-48f0-9aad-a25617eea0b5",
"ParentTaskId": "a2dab8ab-8699-4a17-ba49-75d7920f55bd",
"Integration": {
"IntegrationId": "a8a01851-a6d1-4fc7-8d1a-9e7a39e963c1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e475d8d2-eec1-4081-a88a-e5fcc083bbc7": 2.0,
"c114f81e-259c-43b1-9c8d-034d1aa1b9ad": 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": "fe86cd88-f578-4322-ae9f-fef340694981",
"Name": "sample string 1",
"Created": "2026-08-17T16:09:35.235264+00:00",
"Modified": "2026-08-17T16:09:35.235264+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8c7c3cb8-da83-4636-9afd-cabd99ecf9f7",
"014e2983-dc24-4f27-8be6-e1a581c8f599"
],
"NonLaborAssignments": [
{
"Id": "7fa835e6-987c-4a8e-8ef2-08ee485180b6",
"ResourceId": "9a331769-dcea-4222-9570-f10fa8fca087",
"Quantity": 3.0
},
{
"Id": "7fa835e6-987c-4a8e-8ef2-08ee485180b6",
"ResourceId": "9a331769-dcea-4222-9570-f10fa8fca087",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bd3b58e4-60c8-4adb-bb10-174718ac8881",
"Type": 0,
"ResourceId": "b18bb559-9b71-4763-90f0-26dcbc853b2f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "bd3b58e4-60c8-4adb-bb10-174718ac8881",
"Type": 0,
"ResourceId": "b18bb559-9b71-4763-90f0-26dcbc853b2f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "46e30b9f-4024-49aa-a9b8-f6fbafba8df6",
"WorkTypeParentId": "e481e804-7c19-4c40-885a-d9d090c020c2",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ac72ed89-7e05-4ac4-b8f0-f3985b18dc60",
"UPN": "d6db2a4f-b480-49b9-9a2a-bf107ba00654",
"PostDate": "2026-08-17T16:09:35.235264+00:00",
"Comment": "sample string 4",
"CC": [
"66150607-b026-4037-b4f2-fc0fdb225f08",
"ac154f96-1958-44ee-9986-c272f57be64b"
],
"Users": [
"ffef1769-d8de-49dd-9b83-8b4a989fff44",
"3feb0eed-9dea-46d3-be3f-7f9d611688b4"
]
},
{
"Id": "ac72ed89-7e05-4ac4-b8f0-f3985b18dc60",
"UPN": "d6db2a4f-b480-49b9-9a2a-bf107ba00654",
"PostDate": "2026-08-17T16:09:35.235264+00:00",
"Comment": "sample string 4",
"CC": [
"66150607-b026-4037-b4f2-fc0fdb225f08",
"ac154f96-1958-44ee-9986-c272f57be64b"
],
"Users": [
"ffef1769-d8de-49dd-9b83-8b4a989fff44",
"3feb0eed-9dea-46d3-be3f-7f9d611688b4"
]
}
],
"StartDate": "2026-08-17T16:09:35.235264+00:00",
"DueDate": "2026-08-17T16:09:35.235264+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1e87fb46-9f25-4c93-b519-50653b97677e": "4000276e-e48b-44e2-b4d8-63acf2fb0011",
"216759af-500f-4d6f-9808-26d8fa60999c": "0229d53e-55d1-4368-8cfa-3c8b3a58e20b"
},
"HasUpdates": true,
"Modified": "2026-08-17T16:09:35.235264+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-08-17T16:09:35.235264+00:00"
},
"LastComment": "2026-08-17T16:09:35.235264+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "20f40903-49aa-45a9-abd4-22d7cd5b8902",
"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": "cc1d1797-debe-4cd4-b810-817676dab2d1",
"id": "cff23385-9481-4b60-a547-374e2e50409a",
"ConfigId": "c840a01c-9760-414e-961d-219362a6cfde"
}