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": "93cb8411-8c93-4295-865f-b968bedb3d7d",
"ParentTaskId": "cd34df87-14f7-49a5-aaf8-27f1928aeb9f",
"Integration": {
"IntegrationId": "19148950-b42d-4d30-9206-c1093dee664e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"224ebbed-c600-45c8-a6b0-6110f456e56b": 2.0,
"7bb8ea56-cc05-491d-8dd9-fff75221ddbe": 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": "8fcf8ae0-efb4-4e6e-b7b4-615dce260610",
"Name": "sample string 1",
"Created": "2026-06-18T00:44:49.5321071+00:00",
"Modified": "2026-06-18T00:44:49.5321071+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"426f747f-6b09-41db-8226-1e3dd41da789",
"0cd129f1-b62a-4099-80c9-83f1a0ca6b10"
],
"NonLaborAssignments": [
{
"Id": "cf5b109b-c7d5-4cb0-95a6-dc91b49a0e25",
"ResourceId": "09fb75c5-b868-431d-befd-a8128ec081ea",
"Quantity": 3.0
},
{
"Id": "cf5b109b-c7d5-4cb0-95a6-dc91b49a0e25",
"ResourceId": "09fb75c5-b868-431d-befd-a8128ec081ea",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6f6695a4-4ba4-4f67-9fd4-586c00e5ac53",
"Type": 0,
"ResourceId": "92d24678-4374-4014-a8e6-0653c26231fd",
"Units": 3.0
},
{
"Id": "6f6695a4-4ba4-4f67-9fd4-586c00e5ac53",
"Type": 0,
"ResourceId": "92d24678-4374-4014-a8e6-0653c26231fd",
"Units": 3.0
}
],
"ParentId": "3999eb79-0695-4151-b17b-ae7f84520fa8",
"WorkTypeParentId": "9ecbf470-613c-49c0-ae2b-b67ce9a496fb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7b35bc4c-6b27-4b76-9fcd-52387d6c0fb4",
"UPN": "2eeca120-5794-4874-8b52-a44abea5c6bf",
"PostDate": "2026-06-18T00:44:49.5321071+00:00",
"Comment": "sample string 4",
"CC": [
"00993a99-e6a4-474a-b317-556536d9eb78",
"a1d2d875-ec62-45b9-a8e4-243804bb3421"
],
"Users": [
"81039e99-c6fa-4141-9562-9298cc6b09a3",
"a2dcb93d-e0b8-47dc-b0a6-f221785c2792"
]
},
{
"Id": "7b35bc4c-6b27-4b76-9fcd-52387d6c0fb4",
"UPN": "2eeca120-5794-4874-8b52-a44abea5c6bf",
"PostDate": "2026-06-18T00:44:49.5321071+00:00",
"Comment": "sample string 4",
"CC": [
"00993a99-e6a4-474a-b317-556536d9eb78",
"a1d2d875-ec62-45b9-a8e4-243804bb3421"
],
"Users": [
"81039e99-c6fa-4141-9562-9298cc6b09a3",
"a2dcb93d-e0b8-47dc-b0a6-f221785c2792"
]
}
],
"StartDate": "2026-06-18T00:44:49.5321071+00:00",
"DueDate": "2026-06-18T00:44:49.5321071+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9402ab08-a37f-4544-a188-b8a26fe032a4": "f6c8f93f-a6aa-483b-b75c-30a2ef90e846",
"9845f96b-3da7-47bf-9b74-31705a1694b2": "3082dbce-5345-47a9-8504-cf5afb73723d"
},
"HasUpdates": true,
"Modified": "2026-06-18T00:44:49.5321071+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-18T00:44:49.5321071+00:00"
},
"LastComment": "2026-06-18T00:44:49.5321071+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d2810a4c-aa05-4906-83f5-9ea90a6614a8",
"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": "585def12-d43e-490c-a4fb-780bef660708",
"id": "d934d662-9c71-4777-bc6d-48abf12d06eb",
"ConfigId": "0c1f0b81-57b2-47e6-bad0-8c3026c09e9f"
}