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": "70629f22-5500-4ed9-ba7f-49e9e1eefcd6",
"ParentTaskId": "30f047c7-9aa0-45f0-bb5f-eaaa33e716ef",
"Integration": {
"IntegrationId": "0dc75869-a0ee-49db-a879-d5b5fffbd2e7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"84084fc4-ea62-420a-8603-2d51afac25aa": 2.0,
"44be81f9-ef7d-4629-8a59-b8ef84bf1c49": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "ee6ac7b2-0050-4c7d-8e5f-005e99f5bca0",
"Name": "sample string 1",
"Created": "2026-02-01T04:08:56.4654166+00:00",
"Modified": "2026-02-01T04:08:56.4654166+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"75e66529-acaa-4781-b940-383eb7b61c94",
"daa0ea6e-7cc5-4e78-9d36-916e59562ae5"
],
"NonLaborAssignments": [
{
"Id": "ca72a65b-42c7-447e-bbf5-55dece3507e0",
"ResourceId": "ae08358f-e788-4519-96c7-7e4c5b6a728e",
"Quantity": 3.0
},
{
"Id": "ca72a65b-42c7-447e-bbf5-55dece3507e0",
"ResourceId": "ae08358f-e788-4519-96c7-7e4c5b6a728e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d0359c10-c89d-4445-be1e-5e55725d2d9f",
"Type": 0,
"ResourceId": "e947b778-8438-4a06-8de6-70c5467cba53",
"Units": 3.0
},
{
"Id": "d0359c10-c89d-4445-be1e-5e55725d2d9f",
"Type": 0,
"ResourceId": "e947b778-8438-4a06-8de6-70c5467cba53",
"Units": 3.0
}
],
"ParentId": "b586825b-9828-4c64-b55b-80cc60dfccc8",
"WorkTypeParentId": "2735570b-e9dc-4c76-9592-d476f67cff2c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "795666f5-7eb6-4192-bc00-b615b52eb602",
"UPN": "e915306e-7a09-42a3-9241-83bbd5051e37",
"PostDate": "2026-02-01T04:08:56.4810463+00:00",
"Comment": "sample string 4",
"CC": [
"dc52c824-5194-425c-bd73-d6c19e8375ef",
"d1646670-104e-45e6-9b9a-7e523e0e562b"
],
"Users": [
"09760be5-8745-4b5a-a6ac-f3c94771479d",
"3873ee8b-037a-4dc8-b2ff-9b3cd17b58dd"
]
},
{
"Id": "795666f5-7eb6-4192-bc00-b615b52eb602",
"UPN": "e915306e-7a09-42a3-9241-83bbd5051e37",
"PostDate": "2026-02-01T04:08:56.4810463+00:00",
"Comment": "sample string 4",
"CC": [
"dc52c824-5194-425c-bd73-d6c19e8375ef",
"d1646670-104e-45e6-9b9a-7e523e0e562b"
],
"Users": [
"09760be5-8745-4b5a-a6ac-f3c94771479d",
"3873ee8b-037a-4dc8-b2ff-9b3cd17b58dd"
]
}
],
"StartDate": "2026-02-01T04:08:56.4810463+00:00",
"DueDate": "2026-02-01T04:08:56.4810463+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1b70202e-c856-4691-8407-fcd0ac1f23e5": "3eb6f485-4caa-498f-9d1d-57d959e9806d",
"75dd1502-e8fd-4813-ab8b-7426bbf1c787": "08d27158-7edd-4c83-a60f-8f4143754a39"
},
"HasUpdates": true,
"Modified": "2026-02-01T04:08:56.4810463+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-02-01T04:08:56.4810463+00:00"
},
"LastComment": "2026-02-01T04:08:56.4810463+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4d9d97af-18b2-422e-9c11-c0f3ab498f94",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "6f51a34b-2502-4edf-962a-3528fbfc2d0b",
"id": "d8746156-4f12-4bf9-b834-a7634f1cbcb1",
"ConfigId": "9c058a0a-aef6-4aab-958c-e007d877d8ad"
}