ON THIS PAGE
GET /data_classification/high_level_categories
SUMMARY Retrieves a list of high level categories.
Retrieves a list of high level categories.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
sort |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to sort the elements in a list. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The requested list of high level categories was retrieved. |
|
422 |
23003 |
Sorting is only supported for fields "id" or "name". |
422 |
23004 |
The sort field that was provided does not exist. |
422 |
23005 |
Sorting on multiple fields is not supported. |
500 |
1020 |
An error occurred during the attempt to retrieve the list of high level categories. |
Response Description
- id - Number - The ID of the high level category.
- name - String - The name of the high level category.
- description - String - The description of the high level category.
Response Sample
[ { "id": 19000, "name": "Audit", "description": "Audit" }, { "id": 20000, "name": "Risk", "description": "Risk" } ]