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": "0ba1867c-e679-4e8f-8fee-803d6d563a0f",
"ParentTaskId": "d828d8a3-2c33-46b9-b3ea-dbce97a2ea8d",
"Integration": {
"IntegrationId": "26451872-ce27-4228-9ab9-9f5d258042fe",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"903a198d-2b8b-419e-998c-2d872686cceb": 2.0,
"31c5608b-de73-4158-b167-d5d29754368e": 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": "8324a64a-d5d9-48cf-9ee3-f2c3aa97afa4",
"Name": "sample string 1",
"Created": "2026-07-06T11:37:44.166229+00:00",
"Modified": "2026-07-06T11:37:44.166229+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"44e4641c-5438-42fb-9674-fb94279f53ad",
"f0c91b62-e268-451b-bf54-0cb92f69bd4f"
],
"NonLaborAssignments": [
{
"Id": "c2160ded-b696-4d34-8d09-2bfab58073d2",
"ResourceId": "0bb1c770-7d67-4560-8ee8-e5ad1327311a",
"Quantity": 3.0
},
{
"Id": "c2160ded-b696-4d34-8d09-2bfab58073d2",
"ResourceId": "0bb1c770-7d67-4560-8ee8-e5ad1327311a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "04013467-bc15-430d-8f58-768d1c82b6a2",
"Type": 0,
"ResourceId": "3e321c94-fb78-4352-bd94-fc937d1daeb0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "04013467-bc15-430d-8f58-768d1c82b6a2",
"Type": 0,
"ResourceId": "3e321c94-fb78-4352-bd94-fc937d1daeb0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "dae086b8-656a-4d00-83f4-f040f663b2a2",
"WorkTypeParentId": "47cf80ac-7726-4cb7-9986-5349be4ba83a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a3b82a2b-6280-4b35-bfb6-53a22cf3e541",
"UPN": "cf00e84c-a9b5-4736-99dc-82b1e4ec2e4f",
"PostDate": "2026-07-06T11:37:44.1818405+00:00",
"Comment": "sample string 4",
"CC": [
"b105b7e5-1c95-4dc6-9d67-70846990e3cc",
"6330effe-8a54-4057-8258-b14d96c95287"
],
"Users": [
"5c5e4666-8783-4bb3-b5c0-2c639d0d4da6",
"803aed65-45b0-44f2-916b-7e5e2f22d71c"
]
},
{
"Id": "a3b82a2b-6280-4b35-bfb6-53a22cf3e541",
"UPN": "cf00e84c-a9b5-4736-99dc-82b1e4ec2e4f",
"PostDate": "2026-07-06T11:37:44.1818405+00:00",
"Comment": "sample string 4",
"CC": [
"b105b7e5-1c95-4dc6-9d67-70846990e3cc",
"6330effe-8a54-4057-8258-b14d96c95287"
],
"Users": [
"5c5e4666-8783-4bb3-b5c0-2c639d0d4da6",
"803aed65-45b0-44f2-916b-7e5e2f22d71c"
]
}
],
"StartDate": "2026-07-06T11:37:44.1818405+00:00",
"DueDate": "2026-07-06T11:37:44.1818405+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b73c6136-da64-4866-9354-fdde59229e0b": "24c16c29-ec99-4410-90ce-05f0caa16539",
"f10e0fbc-dd35-40bb-9776-03f78af019bb": "99db34a2-bd3d-46db-a21a-89304bd83fd4"
},
"HasUpdates": true,
"Modified": "2026-07-06T11:37:44.1818405+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-07-06T11:37:44.1818405+00:00"
},
"LastComment": "2026-07-06T11:37:44.1818405+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d468e0a6-51ba-4f58-beea-ef548117fafb",
"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": "e190c57c-f195-4b55-8522-ddb87f7f1e15",
"id": "5416cc02-3e57-4bba-9d93-3d136257e80f",
"ConfigId": "b922ab71-1c29-4d0f-9543-e1018a76baee"
}