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": "2db680f5-5ae8-43fd-91f5-a2968c4511bc",
"ParentTaskId": "994492ee-91fc-4c3b-b6da-0a10fca435b7",
"Integration": {
"IntegrationId": "40b0b4b0-c606-4987-b873-683818ad133b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"cd721eac-0d93-4c9b-82b4-5e7cec515758": 2.0,
"932caa24-bdff-4381-9a15-9d9ed396f5b7": 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": "771fc3f3-304b-4992-9390-6a5477fda0a1",
"Name": "sample string 1",
"Created": "2026-05-30T20:00:45.5597924+00:00",
"Modified": "2026-05-30T20:00:45.5597924+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b61660ec-90b1-4da8-b7e3-823ad178ef1b",
"bb7a1df5-c8d6-4154-92ed-9b3c6b81ea06"
],
"NonLaborAssignments": [
{
"Id": "4bbe3acd-668e-46bd-9d6c-ff13d9bb51fe",
"ResourceId": "151f4013-bc80-4c42-9ba0-f0b171aef023",
"Quantity": 3.0
},
{
"Id": "4bbe3acd-668e-46bd-9d6c-ff13d9bb51fe",
"ResourceId": "151f4013-bc80-4c42-9ba0-f0b171aef023",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "357fbfd5-d878-4dfa-8611-e04c7511f6c9",
"Type": 0,
"ResourceId": "eded3b22-a4db-4d91-b564-dc9b091034ac",
"Units": 3.0
},
{
"Id": "357fbfd5-d878-4dfa-8611-e04c7511f6c9",
"Type": 0,
"ResourceId": "eded3b22-a4db-4d91-b564-dc9b091034ac",
"Units": 3.0
}
],
"ParentId": "fbcb6d52-bf39-4aaa-9367-06ac0d0b2836",
"WorkTypeParentId": "a035c9ba-a0e2-45a0-8245-be83e164e37f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6af3dd15-b70e-4701-a6de-5cf3cc96e389",
"UPN": "6c0dc81f-1fdf-4dec-94d3-1719cf732e41",
"PostDate": "2026-05-30T20:00:45.5597924+00:00",
"Comment": "sample string 4",
"CC": [
"691f2e81-aa06-4133-bdf4-eb7916003e2f",
"c1303161-de99-421c-b37e-aca916c84092"
],
"Users": [
"31ba5c50-e34c-416c-bd61-39b7188a3b4d",
"2c76e6fb-f93f-49f0-9f22-f8392c1f338b"
]
},
{
"Id": "6af3dd15-b70e-4701-a6de-5cf3cc96e389",
"UPN": "6c0dc81f-1fdf-4dec-94d3-1719cf732e41",
"PostDate": "2026-05-30T20:00:45.5597924+00:00",
"Comment": "sample string 4",
"CC": [
"691f2e81-aa06-4133-bdf4-eb7916003e2f",
"c1303161-de99-421c-b37e-aca916c84092"
],
"Users": [
"31ba5c50-e34c-416c-bd61-39b7188a3b4d",
"2c76e6fb-f93f-49f0-9f22-f8392c1f338b"
]
}
],
"StartDate": "2026-05-30T20:00:45.5597924+00:00",
"DueDate": "2026-05-30T20:00:45.5597924+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b23f8299-1d28-4ce9-afc9-8ef0e672fd5d": "adf9e869-f1e8-426b-a1cf-f78a2016829d",
"9a10674f-8bc1-462c-ad36-5156f2bc0328": "213dc7bb-e694-4c0b-91b6-f4d31f26bf35"
},
"HasUpdates": true,
"Modified": "2026-05-30T20:00:45.5597924+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-05-30T20:00:45.5597924+00:00"
},
"LastComment": "2026-05-30T20:00:45.5597924+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cb5e74fa-7da9-432d-bc0c-23a0cd6a8e2f",
"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": "538a51b3-6c62-43b4-af09-cefa43f59160",
"id": "cba2e43a-f5ba-4c08-80f4-c4d87da3b0f1",
"ConfigId": "1f8c6e1a-8c30-46e5-b9c5-b1a0e0998a26"
}