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": "33b962db-97c4-42c1-b8d0-a7e99634a902",
"ParentTaskId": "1a372085-949e-427c-b374-b054536852a4",
"Integration": {
"IntegrationId": "1f061fd2-c6b2-4215-9f9a-d1b58fa2562a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9ee7aa55-4a0b-4dc0-9fba-48c16868e6fa": 2.0,
"f42667db-bdd6-463f-86fc-901fc7feef04": 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": "7e1904f4-d3d5-4813-ac16-f41439e93de9",
"Name": "sample string 1",
"Created": "2026-06-14T05:34:40.9968837+00:00",
"Modified": "2026-06-14T05:34:40.9968837+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"631e9a0d-f030-41ec-b3c5-699287e114f0",
"9a70d53e-239e-4547-a23c-f56ae2967b39"
],
"NonLaborAssignments": [
{
"Id": "e68a9457-3def-44de-9360-5278a25b3449",
"ResourceId": "d685cbbe-0678-4b9e-92f7-fce129a9b3cd",
"Quantity": 3.0
},
{
"Id": "e68a9457-3def-44de-9360-5278a25b3449",
"ResourceId": "d685cbbe-0678-4b9e-92f7-fce129a9b3cd",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "92ff4d67-4b10-4b98-96c4-d8db91c454eb",
"Type": 0,
"ResourceId": "6681672c-27b9-4168-bb6c-1877c3051a93",
"Units": 3.0
},
{
"Id": "92ff4d67-4b10-4b98-96c4-d8db91c454eb",
"Type": 0,
"ResourceId": "6681672c-27b9-4168-bb6c-1877c3051a93",
"Units": 3.0
}
],
"ParentId": "3dbaa6ba-63ef-4e49-b712-8f22666d5fe7",
"WorkTypeParentId": "50e810f3-3084-4890-a8bd-92c40ee4e791",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "058ebaeb-6ec1-4cb3-a331-8fbac63bbea4",
"UPN": "c1ebd67c-5eef-4862-a27b-0cee902b3a0d",
"PostDate": "2026-06-14T05:34:40.9968837+00:00",
"Comment": "sample string 4",
"CC": [
"ccd3e53c-032b-45de-9f32-9916995baf59",
"c48f5019-bb55-478f-9df1-87a6280063a9"
],
"Users": [
"72223843-f04f-4b29-b8f2-c22d56495cb6",
"46090fdf-0233-4dcb-ad30-be575f28f3c7"
]
},
{
"Id": "058ebaeb-6ec1-4cb3-a331-8fbac63bbea4",
"UPN": "c1ebd67c-5eef-4862-a27b-0cee902b3a0d",
"PostDate": "2026-06-14T05:34:40.9968837+00:00",
"Comment": "sample string 4",
"CC": [
"ccd3e53c-032b-45de-9f32-9916995baf59",
"c48f5019-bb55-478f-9df1-87a6280063a9"
],
"Users": [
"72223843-f04f-4b29-b8f2-c22d56495cb6",
"46090fdf-0233-4dcb-ad30-be575f28f3c7"
]
}
],
"StartDate": "2026-06-14T05:34:40.9968837+00:00",
"DueDate": "2026-06-14T05:34:40.9968837+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f6d8e6c8-ce09-4aa8-a984-f8ce83b70394": "d1218c72-c0a3-4985-9b47-a7b48f11ef5b",
"38ffa1d6-c0d2-4a22-968a-e6972ebc58cd": "d45e3e62-15e4-4fc0-94de-8f4845b83e44"
},
"HasUpdates": true,
"Modified": "2026-06-14T05:34:40.9968837+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-06-14T05:34:40.9968837+00:00"
},
"LastComment": "2026-06-14T05:34:40.9968837+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4160b848-3237-41a3-89f6-2da13bd69839",
"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": "9308a9ae-7e9d-47e5-a1bb-9dcd379ea918",
"id": "ce7cb7cb-15fe-4ec3-b267-5a27f95e8797",
"ConfigId": "d6b99512-2432-4264-86f8-6394e7067c4a"
}