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": "ae0bdfe8-930b-4359-baf0-d32a92e3f8fe",
"ParentTaskId": "7cfb2dda-0051-4fa8-bf6e-2f8eb02371ca",
"Integration": {
"IntegrationId": "52199f80-449a-4c12-be31-d6752bb5d7ba",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"483c5201-eb5e-4146-93c7-bd75256ef23f": 2.0,
"9498eb18-7768-4071-94b1-64b105ae4d96": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "9b614abe-942d-428a-8a66-81820963e1d5",
"Name": "sample string 1",
"Created": "2025-12-20T19:57:31.1844434+00:00",
"Modified": "2025-12-20T19:57:31.1844434+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"86ad1278-7e14-480d-a61b-13fc49395e01",
"92e46130-8847-4289-9a3d-876a4af574e6"
],
"NonLaborAssignments": [
{
"Id": "06adf3a4-7e8b-43a7-b02a-5b5d366b37fc",
"ResourceId": "a89da2db-2ea8-4d8d-b28b-cbe7b5f93158",
"Quantity": 3.0
},
{
"Id": "06adf3a4-7e8b-43a7-b02a-5b5d366b37fc",
"ResourceId": "a89da2db-2ea8-4d8d-b28b-cbe7b5f93158",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6fde069c-be1e-47ef-8f98-c07dad7f4ae1",
"Type": 0,
"ResourceId": "f7bde119-6a63-4ada-b773-ab95f1f99d1f",
"Units": 3.0
},
{
"Id": "6fde069c-be1e-47ef-8f98-c07dad7f4ae1",
"Type": 0,
"ResourceId": "f7bde119-6a63-4ada-b773-ab95f1f99d1f",
"Units": 3.0
}
],
"ParentId": "71bffff3-34da-4e46-852b-f21c9e9e1616",
"WorkTypeParentId": "70bd83a0-edab-4a0e-9b7f-0d71e9e9cca4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "48557eb1-a7c8-4bcd-bb8a-41a89b148eb4",
"UPN": "b29e5dee-c9d2-44ff-a720-58a3c128ee2f",
"PostDate": "2025-12-20T19:57:31.1844434+00:00",
"Comment": "sample string 4",
"CC": [
"99119217-c2f0-415f-a4c7-c6f992cce29a",
"b217de4a-1a26-463e-af25-75d9168f0dca"
],
"Users": [
"d86259f5-02d8-4fda-9740-16faff09314b",
"79e3ddee-762c-4fe4-b865-05537cbfad25"
]
},
{
"Id": "48557eb1-a7c8-4bcd-bb8a-41a89b148eb4",
"UPN": "b29e5dee-c9d2-44ff-a720-58a3c128ee2f",
"PostDate": "2025-12-20T19:57:31.1844434+00:00",
"Comment": "sample string 4",
"CC": [
"99119217-c2f0-415f-a4c7-c6f992cce29a",
"b217de4a-1a26-463e-af25-75d9168f0dca"
],
"Users": [
"d86259f5-02d8-4fda-9740-16faff09314b",
"79e3ddee-762c-4fe4-b865-05537cbfad25"
]
}
],
"StartDate": "2025-12-20T19:57:31.1844434+00:00",
"DueDate": "2025-12-20T19:57:31.1844434+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b1d83246-e925-4361-a8e9-a2e57d2c38cb": "0c28a1ef-d709-4fd1-910f-8a0d74ba3668",
"70cac476-d7d0-4a36-8fde-baa1ce060188": "b30f9143-3855-4ac2-bb2f-a35e20ddbc91"
},
"HasUpdates": true,
"Modified": "2025-12-20T19:57:31.1844434+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": "2025-12-20T19:57:31.1844434+00:00"
},
"LastComment": "2025-12-20T19:57:31.1844434+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0623bcf4-32d4-4d18-baac-32112eab37b4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "d5c05637-58a2-4460-9105-d00e41745968",
"id": "d19004fa-ceb4-488d-b0c5-201fabe53b68",
"ConfigId": "52c9b625-af6f-490c-ac21-c2f27d282027"
}