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": "704985d2-d922-4d2c-a963-b0192e45bc4e",
"ParentTaskId": "e6c31428-83e7-4538-a02d-27ca97a84fbb",
"Integration": {
"IntegrationId": "69441e4a-596c-4848-a0ba-95b4b8065193",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"579c59af-568d-43e7-9b7d-c7c2575fca53": 2.0,
"d9db4d94-4d2d-4221-99f9-d9c5dbb5f6a7": 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": "60eef75b-6042-4482-af36-b4e084c9c68e",
"Name": "sample string 1",
"Created": "2026-06-18T13:20:25.4384723+00:00",
"Modified": "2026-06-18T13:20:25.4384723+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2cf5e023-5c66-441b-8733-39f7723a9523",
"c512b71b-c7a6-440c-8d91-7831485d813f"
],
"NonLaborAssignments": [
{
"Id": "122ac7c3-0d92-4372-8d7b-ebef92251b95",
"ResourceId": "989e4cc2-709b-4fe4-b227-ccf55b0affb3",
"Quantity": 3.0
},
{
"Id": "122ac7c3-0d92-4372-8d7b-ebef92251b95",
"ResourceId": "989e4cc2-709b-4fe4-b227-ccf55b0affb3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6e8324ee-8ce2-4955-92df-402c0f20f316",
"Type": 0,
"ResourceId": "0c364b6f-f926-4136-990a-4837138b398f",
"Units": 3.0
},
{
"Id": "6e8324ee-8ce2-4955-92df-402c0f20f316",
"Type": 0,
"ResourceId": "0c364b6f-f926-4136-990a-4837138b398f",
"Units": 3.0
}
],
"ParentId": "8eacb6b1-18af-4e79-a1cd-6c16162631fb",
"WorkTypeParentId": "c781fd3c-ad72-4da1-88f8-eee1d8dda8c4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "22c6ee69-4e10-4f67-9260-dd6347488a0d",
"UPN": "24773f3d-28ce-4b02-a163-18df8a338dbd",
"PostDate": "2026-06-18T13:20:25.4384723+00:00",
"Comment": "sample string 4",
"CC": [
"d8cf0ac3-2abc-4213-a661-c3a17a4e97dd",
"db1a26ab-633d-4c61-8448-36ee88970306"
],
"Users": [
"a5ca9d29-f50d-470d-b578-c2d8a7cd35c2",
"ddafb455-e565-4376-a385-02d7eda37694"
]
},
{
"Id": "22c6ee69-4e10-4f67-9260-dd6347488a0d",
"UPN": "24773f3d-28ce-4b02-a163-18df8a338dbd",
"PostDate": "2026-06-18T13:20:25.4384723+00:00",
"Comment": "sample string 4",
"CC": [
"d8cf0ac3-2abc-4213-a661-c3a17a4e97dd",
"db1a26ab-633d-4c61-8448-36ee88970306"
],
"Users": [
"a5ca9d29-f50d-470d-b578-c2d8a7cd35c2",
"ddafb455-e565-4376-a385-02d7eda37694"
]
}
],
"StartDate": "2026-06-18T13:20:25.4384723+00:00",
"DueDate": "2026-06-18T13:20:25.4384723+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bd3fe6a9-6415-4daa-836f-46d3a8a5b961": "269d3ea9-f209-4d02-8d99-a1d970223542",
"3e7a850c-4b67-42d2-a757-745f2d3dcb19": "b28b7432-5ac4-4c28-8298-aa0dfb4512da"
},
"HasUpdates": true,
"Modified": "2026-06-18T13:20:25.4384723+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-18T13:20:25.4384723+00:00"
},
"LastComment": "2026-06-18T13:20:25.4384723+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4835e871-6691-4900-998f-a2b368047ba1",
"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": "7e31c3b4-ad5b-4b0d-8daf-19c2b397370a",
"id": "e9e62efc-1ff4-4aec-a7af-65045e9ea14a",
"ConfigId": "b32b2fad-a29f-43c2-a696-9620d5c973b8"
}