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": "935e735b-6be8-4429-a29b-5e9beb887027",
"ParentTaskId": "66a28aa4-7f5a-4c08-a713-f4023dcb3648",
"Integration": {
"IntegrationId": "1cd135b7-3f97-4f62-b381-3abdf44b0dd1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"976299f0-9478-41d0-9247-c4923bc90db7": 2.0,
"de3a1121-207d-4dda-95eb-14bc43570a51": 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": "193f6331-427c-4caf-8198-b9bc034c0b75",
"Name": "sample string 1",
"Created": "2026-06-28T03:19:06.7571546+00:00",
"Modified": "2026-06-28T03:19:06.7571546+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"86d1bb61-9468-45b4-9c41-62f5d4405404",
"11ffbd32-f46a-4a72-a9c0-5ca4d9f8371f"
],
"NonLaborAssignments": [
{
"Id": "4ab3b6a9-c10e-4f08-a6a2-34ecabaee19d",
"ResourceId": "fb85771b-f97a-4210-8d77-fb681673b33e",
"Quantity": 3.0
},
{
"Id": "4ab3b6a9-c10e-4f08-a6a2-34ecabaee19d",
"ResourceId": "fb85771b-f97a-4210-8d77-fb681673b33e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5953aeb6-3b6a-4017-a8c9-472324969e1e",
"Type": 0,
"ResourceId": "dec54c7b-5ce3-43e9-a283-99795b0873d8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "5953aeb6-3b6a-4017-a8c9-472324969e1e",
"Type": 0,
"ResourceId": "dec54c7b-5ce3-43e9-a283-99795b0873d8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "d2539e3f-1249-403f-9494-d5c02fafd8c4",
"WorkTypeParentId": "c1c1583e-17f3-4880-8abe-b0df7ec12083",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c8875447-8adc-419b-9599-4885a53613c5",
"UPN": "1e8dd2ab-7212-4260-82d5-5eeb57db522a",
"PostDate": "2026-06-28T03:19:06.7571546+00:00",
"Comment": "sample string 4",
"CC": [
"720a635b-4bdb-4e2a-ae9a-bf0cc0ebc3da",
"30f4fa6f-a829-42d0-87c6-444944e34955"
],
"Users": [
"a6e51a34-4639-4457-88cb-69e78d99eed7",
"33c8889b-8d5b-48fe-bc27-43d2f21f042c"
]
},
{
"Id": "c8875447-8adc-419b-9599-4885a53613c5",
"UPN": "1e8dd2ab-7212-4260-82d5-5eeb57db522a",
"PostDate": "2026-06-28T03:19:06.7571546+00:00",
"Comment": "sample string 4",
"CC": [
"720a635b-4bdb-4e2a-ae9a-bf0cc0ebc3da",
"30f4fa6f-a829-42d0-87c6-444944e34955"
],
"Users": [
"a6e51a34-4639-4457-88cb-69e78d99eed7",
"33c8889b-8d5b-48fe-bc27-43d2f21f042c"
]
}
],
"StartDate": "2026-06-28T03:19:06.7571546+00:00",
"DueDate": "2026-06-28T03:19:06.7571546+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"13ce326c-9678-47ef-8e23-2ad3e6210446": "d5b52b72-cf2a-47c3-a44e-c5d97879118f",
"d9a9ae7e-f1af-40a0-95ea-b09e5d21073b": "5f8e8f36-61f1-4831-8bc3-5684fc2705b8"
},
"HasUpdates": true,
"Modified": "2026-06-28T03:19:06.7571546+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-28T03:19:06.7571546+00:00"
},
"LastComment": "2026-06-28T03:19:06.7571546+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ed5df20c-56a9-4161-a54a-fe6bdcf05066",
"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": "9a9a2991-d15b-43f0-ad1f-a5cb86ba5aee",
"id": "e67cff19-5fd1-4efe-840e-fb22db8ac4af",
"ConfigId": "10bfc9b3-2ad5-427c-ad22-059b2a54196e"
}