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": "f1300e11-a540-4e82-8f9c-1f917eefe015",
"ParentTaskId": "f3ca66ec-01ca-427c-b769-ecd909feac4c",
"Integration": {
"IntegrationId": "0422a2e0-1457-42c0-a3bf-44b686b88b8a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"270a1701-ebd0-44df-a70c-d9e386f35988": 2.0,
"bf155b10-0e13-4c41-8dc1-6110acfe6001": 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": "68614b38-1466-4e8f-93fe-9266dd6e3c52",
"Name": "sample string 1",
"Created": "2026-08-04T21:47:26.9748001+00:00",
"Modified": "2026-08-04T21:47:26.9748001+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"52822c05-225b-43a4-a2dc-368b798d4ef5",
"6a65f206-4481-4daf-93ab-12266abae5ec"
],
"NonLaborAssignments": [
{
"Id": "081e5f02-6524-46dd-91e0-33fdce00927e",
"ResourceId": "dee3613c-1163-4622-a8ff-fa0c0cfc7c10",
"Quantity": 3.0
},
{
"Id": "081e5f02-6524-46dd-91e0-33fdce00927e",
"ResourceId": "dee3613c-1163-4622-a8ff-fa0c0cfc7c10",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "23420665-d168-4e75-9376-aa1c20e7a04c",
"Type": 0,
"ResourceId": "262c7802-99d9-414f-b1bb-da5d7bf1bef1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "23420665-d168-4e75-9376-aa1c20e7a04c",
"Type": 0,
"ResourceId": "262c7802-99d9-414f-b1bb-da5d7bf1bef1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "762ade77-6fcb-4a25-8236-9a9981cbee98",
"WorkTypeParentId": "25042ec0-5c80-4947-9184-a9bdf32272ed",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f5535878-7e0c-49e8-bb93-fac19b4dff5e",
"UPN": "0af6ef19-ce5c-4d22-94a7-761db9e3bacd",
"PostDate": "2026-08-04T21:47:26.9748001+00:00",
"Comment": "sample string 4",
"CC": [
"9707525a-8a77-4e1a-91a1-08713065f661",
"b146e9b6-f2ac-40b1-960a-57163271f3a7"
],
"Users": [
"9af4d2bf-869f-4ae6-b3af-389073160d95",
"8870202a-03d3-4ac3-bea5-41cb5b27452a"
]
},
{
"Id": "f5535878-7e0c-49e8-bb93-fac19b4dff5e",
"UPN": "0af6ef19-ce5c-4d22-94a7-761db9e3bacd",
"PostDate": "2026-08-04T21:47:26.9748001+00:00",
"Comment": "sample string 4",
"CC": [
"9707525a-8a77-4e1a-91a1-08713065f661",
"b146e9b6-f2ac-40b1-960a-57163271f3a7"
],
"Users": [
"9af4d2bf-869f-4ae6-b3af-389073160d95",
"8870202a-03d3-4ac3-bea5-41cb5b27452a"
]
}
],
"StartDate": "2026-08-04T21:47:26.9748001+00:00",
"DueDate": "2026-08-04T21:47:26.9748001+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"85a970e8-afda-447c-87c3-9cc982c86ff0": "303d522f-cb2b-40e3-96c7-ad5052f10f3d",
"a43ef992-a623-4389-bdbf-15656b1422f1": "c47d9ebf-2322-42a9-81d7-7369c85d4c87"
},
"HasUpdates": true,
"Modified": "2026-08-04T21:47:26.9748001+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-04T21:47:26.9748001+00:00"
},
"LastComment": "2026-08-04T21:47:26.9748001+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f2028099-bd6d-4335-8c0e-a2ad58991254",
"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": "1fa3207d-ff95-4ba1-9f11-6fea192768db",
"id": "30a26853-c596-4b68-8905-a5bd67ebdcb6",
"ConfigId": "4fc90f8e-1ed9-45e1-826f-94186063d4ff"
}