ON THIS PAGE
GET /data_classification/low_level_categories
SUMMARY Retrieves a list of low level categories.
Retrieves a list of low level categories.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
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. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The requested list of low level categories was retrieved. |
|
422 |
23053 |
Sorting is only supported for fields "id" or "name" |
422 |
23054 |
The sort field that was provided does not exist. |
422 |
23055 |
Sorting on multiple fields is not supported. |
500 |
1020 |
An error occurred during the attempt to retrieve the list of low level categories. |
Response Description
- id - Number - The ID of the low level category.
- name - String - The name of the low level category.
- description - String - The description of the low level category.
- severity - Number - The severity of the low level category.
- high_level_category_id - Number - The ID of the parent high level category.
Response Sample
[ { "id": 19001, "name": "General Audit Event", "description": "General Audit Event", "high_level_category_id": 19000, "severity" : 0 }, { "id": 19002, "name": "Built-in Execution", "description": " Built-in Execution", "high_level_category_id": 19000, "severity" : 0 } ]