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": "24af7cbb-aa8b-4b54-a46c-bbfdb8b3b34d",
"ParentTaskId": "68d6854b-8222-4e7b-9975-956c460abf0d",
"Integration": {
"IntegrationId": "3513e602-5871-47dc-a973-bb588c2d3d51",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6ad1c12f-b7a5-43ff-9dee-4f489c846ca7": 2.0,
"6438d90c-a872-42c1-a9fc-28309dd33770": 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": "47883763-6082-4a5e-9a4d-dc57ada7a06d",
"Name": "sample string 1",
"Created": "2026-08-12T07:54:03.9135326+00:00",
"Modified": "2026-08-12T07:54:03.9135326+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f75bb62a-db00-4669-844b-d9b1bfd9b9fa",
"35968060-7876-4f7c-9b91-a7b092d04953"
],
"NonLaborAssignments": [
{
"Id": "010e2fa1-bb16-40be-8289-c8c46dbd5b52",
"ResourceId": "aceaa183-30ac-41c5-b4f7-02dd92339822",
"Quantity": 3.0
},
{
"Id": "010e2fa1-bb16-40be-8289-c8c46dbd5b52",
"ResourceId": "aceaa183-30ac-41c5-b4f7-02dd92339822",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6f9465ca-224a-4f1d-b7a1-a339ac222789",
"Type": 0,
"ResourceId": "01f50895-b2ba-4069-beec-2b2195645529",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "6f9465ca-224a-4f1d-b7a1-a339ac222789",
"Type": 0,
"ResourceId": "01f50895-b2ba-4069-beec-2b2195645529",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "438ff86f-94b4-48ca-bb30-efdae7d00ad3",
"WorkTypeParentId": "9a89a101-5fae-4ac9-b031-9b42131d0532",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8114e739-a578-4898-9c43-aebd1bf6cdba",
"UPN": "2ac2c312-f9ee-4cef-89af-174370612b58",
"PostDate": "2026-08-12T07:54:03.9135326+00:00",
"Comment": "sample string 4",
"CC": [
"1067ea92-9fdb-4ad9-8424-8e8b186cf677",
"2d3e13c3-2172-4047-b0c7-cf2231603a3e"
],
"Users": [
"e512dc60-ee2f-40de-8042-a24896aff595",
"5f7b478d-4ce7-497b-9923-cf2271e47fc0"
]
},
{
"Id": "8114e739-a578-4898-9c43-aebd1bf6cdba",
"UPN": "2ac2c312-f9ee-4cef-89af-174370612b58",
"PostDate": "2026-08-12T07:54:03.9135326+00:00",
"Comment": "sample string 4",
"CC": [
"1067ea92-9fdb-4ad9-8424-8e8b186cf677",
"2d3e13c3-2172-4047-b0c7-cf2231603a3e"
],
"Users": [
"e512dc60-ee2f-40de-8042-a24896aff595",
"5f7b478d-4ce7-497b-9923-cf2271e47fc0"
]
}
],
"StartDate": "2026-08-12T07:54:03.9135326+00:00",
"DueDate": "2026-08-12T07:54:03.9135326+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"06d58d6a-a2c7-44d2-a52d-3f3c1528eac0": "e3093222-1787-4c54-883e-ec8f36be9dc7",
"24d27f9c-85a1-40a3-bae5-26c1186be452": "1dcb4654-72a4-4be9-a1d5-7b099cd17441"
},
"HasUpdates": true,
"Modified": "2026-08-12T07:54:03.9135326+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-08-12T07:54:03.9135326+00:00"
},
"LastComment": "2026-08-12T07:54:03.9135326+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0be4d588-5b31-4b1a-a0d0-4ef812254f98",
"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": "10024140-de7f-48f0-b742-ecda93eeaa2d",
"id": "d1019127-b50f-46d9-abb3-e3cbb71634fb",
"ConfigId": "d150d7b7-06d7-417d-991b-2689df0d0c46"
}