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": "a33805d5-5051-4901-8a81-98794e01cde2",
"ParentTaskId": "81841a07-b572-4310-a536-8287639cda35",
"Integration": {
"IntegrationId": "d20cc623-fa07-4ff7-b8c1-61d5e8a55e82",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a14743e4-5dee-473c-8c06-dec2ceb2c797": 2.0,
"f09a8bb2-8c23-4576-a49c-b4e7b833eab7": 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": "b421e2e9-8254-4510-9ead-39defccd976c",
"Name": "sample string 1",
"Created": "2026-07-22T01:19:31.0464213+00:00",
"Modified": "2026-07-22T01:19:31.0464213+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"356fd42e-66c8-4b74-8be2-7e94f2753cad",
"b661a0e5-9821-4cd7-9b26-68b5fe716b45"
],
"NonLaborAssignments": [
{
"Id": "5946a30f-d3e7-4137-acb2-5482afa3a2f8",
"ResourceId": "841198af-b920-4a15-b566-6164a93fc4f0",
"Quantity": 3.0
},
{
"Id": "5946a30f-d3e7-4137-acb2-5482afa3a2f8",
"ResourceId": "841198af-b920-4a15-b566-6164a93fc4f0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8a9d5b66-a18a-49c6-b596-187316d0b049",
"Type": 0,
"ResourceId": "4e3bb143-7a03-4c5f-ad54-67c15ba40ad9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "8a9d5b66-a18a-49c6-b596-187316d0b049",
"Type": 0,
"ResourceId": "4e3bb143-7a03-4c5f-ad54-67c15ba40ad9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "d0d453aa-9af3-433f-9aec-abedd30ecff2",
"WorkTypeParentId": "f02a38d9-cdd1-453d-ad9b-25d5fad63322",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "207f323b-acfd-492b-a02b-492055d5921d",
"UPN": "88169f74-635b-45cf-8bdd-39d5df4a74f1",
"PostDate": "2026-07-22T01:19:31.0464213+00:00",
"Comment": "sample string 4",
"CC": [
"5b95ce80-ccc7-4714-81db-fd43a397db7a",
"8bf1f8b3-b65d-45d6-b113-b446f8159aee"
],
"Users": [
"a3cc4d28-b892-4752-9cce-e19c397f89f5",
"0b51aadb-19c1-4e34-994a-69bb696116e8"
]
},
{
"Id": "207f323b-acfd-492b-a02b-492055d5921d",
"UPN": "88169f74-635b-45cf-8bdd-39d5df4a74f1",
"PostDate": "2026-07-22T01:19:31.0464213+00:00",
"Comment": "sample string 4",
"CC": [
"5b95ce80-ccc7-4714-81db-fd43a397db7a",
"8bf1f8b3-b65d-45d6-b113-b446f8159aee"
],
"Users": [
"a3cc4d28-b892-4752-9cce-e19c397f89f5",
"0b51aadb-19c1-4e34-994a-69bb696116e8"
]
}
],
"StartDate": "2026-07-22T01:19:31.0464213+00:00",
"DueDate": "2026-07-22T01:19:31.0464213+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2482ce20-5edb-4f03-b3bd-bc761b830ff4": "cb845191-060d-4bc5-bd5f-c25f2a5884fe",
"7608a0d6-fa32-4b86-984f-65ab820ae086": "63035dd2-85a0-47b8-8b8a-154d727a9bfc"
},
"HasUpdates": true,
"Modified": "2026-07-22T01:19:31.0464213+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-22T01:19:31.0464213+00:00"
},
"LastComment": "2026-07-22T01:19:31.0464213+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "01ebe72d-1762-4170-955b-7afec2e53802",
"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": "68c3d8ce-fdf3-4592-b050-177064641344",
"id": "8d534ebd-44d9-4a74-ab71-4bc7ff9ab825",
"ConfigId": "5b8ebf32-85ac-4868-8ef9-dd5cc12f2f09"
}