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": "c1e836ab-3198-41d1-8b45-6f089f5c90b2",
"ParentTaskId": "1b3befaf-7423-40d3-bae6-a65b31dabc73",
"Integration": {
"IntegrationId": "828c4e7d-a4da-4ec5-a633-df8a797d05e3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2b024f4c-5bef-4d45-8352-a3c42ea728f8": 2.0,
"8f1f5c42-a8f6-45f4-ae5b-7c393a0b39bc": 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": "eb3105aa-32ba-41d1-b49d-a0a30cf90330",
"Name": "sample string 1",
"Created": "2026-08-25T21:00:44.761917+00:00",
"Modified": "2026-08-25T21:00:44.761917+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"82e5a076-7a5e-4454-b80c-555afd4af65c",
"83459314-c182-4650-8934-f2a05aa7b209"
],
"NonLaborAssignments": [
{
"Id": "756fb660-2194-4aac-bdd9-43e06cd3c6d8",
"ResourceId": "a8cd32a8-2f2e-485d-a74c-c779655a535b",
"Quantity": 3.0
},
{
"Id": "756fb660-2194-4aac-bdd9-43e06cd3c6d8",
"ResourceId": "a8cd32a8-2f2e-485d-a74c-c779655a535b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "92587326-a511-4e4d-9adc-60c7f77f59fd",
"Type": 0,
"ResourceId": "e0223626-f529-4035-9af1-090880d69c62",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "92587326-a511-4e4d-9adc-60c7f77f59fd",
"Type": 0,
"ResourceId": "e0223626-f529-4035-9af1-090880d69c62",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "18d66673-e043-4765-a6ab-c881ed3c0219",
"WorkTypeParentId": "b898ea30-b307-40be-8b0d-39e7c128bb6c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d5ef6bca-a8cc-4a5e-84be-360697d4abc7",
"UPN": "98d973ab-c7f1-427f-9d11-209974be4b34",
"PostDate": "2026-08-25T21:00:44.761917+00:00",
"Comment": "sample string 4",
"CC": [
"5a04d5e4-9063-4796-9947-79db5ba87ab0",
"5c8a854e-8e68-4cec-997d-9938ef8a663a"
],
"Users": [
"daabb8db-533c-4697-b998-165ec34a4cc4",
"62dabdb4-742a-4120-81ab-9ecf65584ef8"
]
},
{
"Id": "d5ef6bca-a8cc-4a5e-84be-360697d4abc7",
"UPN": "98d973ab-c7f1-427f-9d11-209974be4b34",
"PostDate": "2026-08-25T21:00:44.761917+00:00",
"Comment": "sample string 4",
"CC": [
"5a04d5e4-9063-4796-9947-79db5ba87ab0",
"5c8a854e-8e68-4cec-997d-9938ef8a663a"
],
"Users": [
"daabb8db-533c-4697-b998-165ec34a4cc4",
"62dabdb4-742a-4120-81ab-9ecf65584ef8"
]
}
],
"StartDate": "2026-08-25T21:00:44.7775406+00:00",
"DueDate": "2026-08-25T21:00:44.7775406+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fef8c2ce-53e1-43f9-9833-64ed17b7bc3e": "a64428ab-c187-46d2-a1f9-1e5980060677",
"1796d2c9-3e55-4910-8e5f-a14beedf3f5c": "0b291654-fc3e-48ad-a30b-37ecb84bf578"
},
"HasUpdates": true,
"Modified": "2026-08-25T21:00:44.7775406+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-25T21:00:44.7775406+00:00"
},
"LastComment": "2026-08-25T21:00:44.7775406+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9548a58e-5771-4238-8c36-13bec95d4e2c",
"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": "146784ef-2489-419d-b6ae-bf8807352135",
"id": "1890d091-5872-43aa-ae9f-370ff54bf0d8",
"ConfigId": "7ca1c311-3263-4d24-b2e3-7e5cb8b16620"
}