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": "316cc360-144e-4132-98aa-994afdd8f403",
"ParentTaskId": "c629b037-7318-4b8a-ad11-dfdcc6aea794",
"Integration": {
"IntegrationId": "e1f931e7-499b-4d2d-8102-701b56aad57b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fc5907c3-30f2-43f9-8728-89352653bc8e": 2.0,
"027670a9-1bdd-4ea1-a22e-cd23395b4e70": 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": "01e05ec3-4fff-49b8-b91b-6b7b68f916fd",
"Name": "sample string 1",
"Created": "2026-06-04T17:35:10.2367265+00:00",
"Modified": "2026-06-04T17:35:10.2367265+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2aff53a9-7790-4195-933e-5a57ed12e110",
"dda9ad8a-94cc-42f3-a34f-97c298939fc2"
],
"NonLaborAssignments": [
{
"Id": "178b1da8-fb25-4198-bf87-7b2c690583c0",
"ResourceId": "7cde7477-b794-4ae4-8c9c-6a4f641dbe9e",
"Quantity": 3.0
},
{
"Id": "178b1da8-fb25-4198-bf87-7b2c690583c0",
"ResourceId": "7cde7477-b794-4ae4-8c9c-6a4f641dbe9e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6ed5d6be-651b-4ce1-9e37-34e0f64f410e",
"Type": 0,
"ResourceId": "51933759-db3c-4ced-b12f-8e7574078985",
"Units": 3.0
},
{
"Id": "6ed5d6be-651b-4ce1-9e37-34e0f64f410e",
"Type": 0,
"ResourceId": "51933759-db3c-4ced-b12f-8e7574078985",
"Units": 3.0
}
],
"ParentId": "0a7fed2a-fd73-433c-b832-c6a9650cdcd6",
"WorkTypeParentId": "d3c994a4-da87-4b65-ae3a-696cdfd0c407",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ce516189-d86f-4f9f-9618-df6a2fcad53d",
"UPN": "98d96727-bd67-4a61-ba8c-58ad577389b2",
"PostDate": "2026-06-04T17:35:10.2367265+00:00",
"Comment": "sample string 4",
"CC": [
"92cfac06-a380-41b4-b679-d5bbde723f66",
"096b47b7-5403-4422-86dc-f7101fd2212a"
],
"Users": [
"d5f5ee20-00cb-4e3f-8f55-a853701b4975",
"272e78ed-24b0-4db9-9d96-57967530f9d8"
]
},
{
"Id": "ce516189-d86f-4f9f-9618-df6a2fcad53d",
"UPN": "98d96727-bd67-4a61-ba8c-58ad577389b2",
"PostDate": "2026-06-04T17:35:10.2367265+00:00",
"Comment": "sample string 4",
"CC": [
"92cfac06-a380-41b4-b679-d5bbde723f66",
"096b47b7-5403-4422-86dc-f7101fd2212a"
],
"Users": [
"d5f5ee20-00cb-4e3f-8f55-a853701b4975",
"272e78ed-24b0-4db9-9d96-57967530f9d8"
]
}
],
"StartDate": "2026-06-04T17:35:10.2367265+00:00",
"DueDate": "2026-06-04T17:35:10.2367265+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4eedbd0c-bc5e-4714-a349-f1ec5e10dcc4": "2a7aa0f2-bce6-478b-a5e7-f8b1608486d5",
"6fbc6c97-5752-4068-bbc5-57902cb53bc4": "530457ea-af98-486e-8348-5fa37a6b1ff0"
},
"HasUpdates": true,
"Modified": "2026-06-04T17:35:10.2367265+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-04T17:35:10.2367265+00:00"
},
"LastComment": "2026-06-04T17:35:10.2367265+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "34c67f50-377a-481f-b03b-0f97fdf62af9",
"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": "5e09117b-4d00-48e9-985b-2716bec0be8f",
"id": "2ece3ad4-b616-46cb-8044-103a33e3432f",
"ConfigId": "cd361892-8b9a-42e6-b6d6-bce219535234"
}