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": "ba8751de-20ef-4cf9-a152-318e414e9fbc",
"ParentTaskId": "d153e298-72b5-40a6-9266-486f51088492",
"Integration": {
"IntegrationId": "68a8134b-850a-419e-b11f-ecc939166871",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ede5deac-0b5b-4f37-b713-db4725a79086": 2.0,
"0d18fbad-3e13-46d2-af3a-195f336c3208": 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": "bb48842f-57ab-4101-9bd5-0cc2a6c80344",
"Name": "sample string 1",
"Created": "2026-06-25T14:23:25.3792995+00:00",
"Modified": "2026-06-25T14:23:25.3792995+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ce8ffc50-8c58-4c0c-ba7a-759f9e77fca2",
"b7cf64b4-2eeb-459c-8c4c-9e21c07fd242"
],
"NonLaborAssignments": [
{
"Id": "dab3ee0f-32cb-4cc0-8cb7-744668bdc44a",
"ResourceId": "71835161-9ccf-44ae-b818-b94336a55ca4",
"Quantity": 3.0
},
{
"Id": "dab3ee0f-32cb-4cc0-8cb7-744668bdc44a",
"ResourceId": "71835161-9ccf-44ae-b818-b94336a55ca4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8f356748-ed3a-4135-86cc-aa1b9f1a1da5",
"Type": 0,
"ResourceId": "88a3d85b-ab6b-4f28-9a01-c48d0d031509",
"Units": 3.0
},
{
"Id": "8f356748-ed3a-4135-86cc-aa1b9f1a1da5",
"Type": 0,
"ResourceId": "88a3d85b-ab6b-4f28-9a01-c48d0d031509",
"Units": 3.0
}
],
"ParentId": "5091eb47-12b9-457f-aa1c-5964003ece04",
"WorkTypeParentId": "6a4cedd0-a171-4631-823d-5e2c71cb6787",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "dd0fd252-5acc-46f4-8fa2-b71f8d2ceece",
"UPN": "e9ab55f2-7296-433f-8779-4e944632ed3a",
"PostDate": "2026-06-25T14:23:25.3792995+00:00",
"Comment": "sample string 4",
"CC": [
"c11dd4bf-432e-410e-9e88-7f73f0e3c314",
"cc61b610-c61f-4d2c-8c94-47f23dfe74ef"
],
"Users": [
"22869e18-daa8-4003-83a7-00476a34b2cc",
"ddaf384c-b2eb-448f-b979-b660fbc182b0"
]
},
{
"Id": "dd0fd252-5acc-46f4-8fa2-b71f8d2ceece",
"UPN": "e9ab55f2-7296-433f-8779-4e944632ed3a",
"PostDate": "2026-06-25T14:23:25.3792995+00:00",
"Comment": "sample string 4",
"CC": [
"c11dd4bf-432e-410e-9e88-7f73f0e3c314",
"cc61b610-c61f-4d2c-8c94-47f23dfe74ef"
],
"Users": [
"22869e18-daa8-4003-83a7-00476a34b2cc",
"ddaf384c-b2eb-448f-b979-b660fbc182b0"
]
}
],
"StartDate": "2026-06-25T14:23:25.3792995+00:00",
"DueDate": "2026-06-25T14:23:25.3792995+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4be55f53-bd6f-4c51-98e5-626d0153c5d7": "b85bbe57-4623-4a05-8074-fe36f440ffd7",
"d918aef9-591f-405c-b0a7-7a7b5e0ae257": "58d5bfde-9cdd-489f-b85c-9517a4e1ba53"
},
"HasUpdates": true,
"Modified": "2026-06-25T14:23:25.3792995+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-25T14:23:25.3792995+00:00"
},
"LastComment": "2026-06-25T14:23:25.3792995+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e0a2b3ce-7884-4b64-9383-c50e0b46598a",
"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": "f71c0c63-8ca2-4c23-998b-8b5afc9c56e2",
"id": "18a8380e-f68e-43f0-ac4a-19f2a763aa31",
"ConfigId": "12c0f9e3-66e5-4c11-a941-9aa4d4cc99aa"
}