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": "b21ddaac-7eee-4694-be18-17eb25eb57cd",
"ParentTaskId": "202617cb-37a6-462b-b0a1-e0c6212a10e8",
"Integration": {
"IntegrationId": "1947292f-626a-4a6c-b4b2-6ce1e1b0bf41",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9990b0d3-f977-43c7-b007-dcee66d72591": 2.0,
"7abb0ada-75a4-4c55-8963-04619ec90672": 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": "9d81bced-580e-43f2-88ef-c90200690e75",
"Name": "sample string 1",
"Created": "2026-07-09T10:54:29.0896938+00:00",
"Modified": "2026-07-09T10:54:29.0896938+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"09e8b058-a175-4594-b8f8-5851f40a2c41",
"c4bc5e24-2b77-45ac-943d-467728c4009d"
],
"NonLaborAssignments": [
{
"Id": "1964f626-2c2e-4004-b0bf-606ae26d7b71",
"ResourceId": "2a3fc31f-3548-43a9-9e34-61c47fa04119",
"Quantity": 3.0
},
{
"Id": "1964f626-2c2e-4004-b0bf-606ae26d7b71",
"ResourceId": "2a3fc31f-3548-43a9-9e34-61c47fa04119",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "de5a7c58-6df0-4e09-ab1a-b4f5df559e27",
"Type": 0,
"ResourceId": "bd4cee22-2640-4b45-8719-379216d8d368",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "de5a7c58-6df0-4e09-ab1a-b4f5df559e27",
"Type": 0,
"ResourceId": "bd4cee22-2640-4b45-8719-379216d8d368",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "953a94df-8646-4f18-9cc3-e56e97aaa2ea",
"WorkTypeParentId": "d81c849e-3057-4883-bc69-8543b22342bb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3cd59b97-a2e6-41f6-b8f4-1b993988e226",
"UPN": "b23fb0cb-b927-4fc3-8654-3447623703aa",
"PostDate": "2026-07-09T10:54:29.0896938+00:00",
"Comment": "sample string 4",
"CC": [
"9c4c92e5-151f-4692-b2e8-c94897010bcc",
"a9237e3d-e69d-4450-aa51-2f42452edc7c"
],
"Users": [
"1ec72ac4-f8ae-46b2-96fc-f28dfb43a66b",
"406ee015-f7fa-4017-a66f-989eaad36e6d"
]
},
{
"Id": "3cd59b97-a2e6-41f6-b8f4-1b993988e226",
"UPN": "b23fb0cb-b927-4fc3-8654-3447623703aa",
"PostDate": "2026-07-09T10:54:29.0896938+00:00",
"Comment": "sample string 4",
"CC": [
"9c4c92e5-151f-4692-b2e8-c94897010bcc",
"a9237e3d-e69d-4450-aa51-2f42452edc7c"
],
"Users": [
"1ec72ac4-f8ae-46b2-96fc-f28dfb43a66b",
"406ee015-f7fa-4017-a66f-989eaad36e6d"
]
}
],
"StartDate": "2026-07-09T10:54:29.0896938+00:00",
"DueDate": "2026-07-09T10:54:29.0896938+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7d12bf34-13ee-4803-a26b-23ee48bc8965": "b5d1150b-b5a5-4a25-a971-c6c7e170af78",
"ffa71438-0b30-44df-8135-520ee1f20fe0": "6132ff43-4668-472e-aebc-877b0ccf5d72"
},
"HasUpdates": true,
"Modified": "2026-07-09T10:54:29.0896938+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-07-09T10:54:29.0896938+00:00"
},
"LastComment": "2026-07-09T10:54:29.0896938+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b512922b-5a8c-463a-9979-7fa35f2d1e92",
"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": "50412923-27f6-4add-af52-10052a2130ca",
"id": "c60e9d30-a628-4d27-931f-31e5fbc507f8",
"ConfigId": "3bfa38b8-3c57-44e5-a20e-16e6b97cd999"
}