Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /data_classification/high_level_categories

Retrieves a list of high level categories.

Retrieves a list of high level categories.

Table 1: GET /data_classification/high_level_categories Resource Details

MIME Type

application/json

Table 2: GET /data_classification/high_level_categories Request Parameter Details

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.

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.

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.

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.

Table 3: GET /data_classification/high_level_categories Response Codes

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

A list of high level categories. A high level category contains the following fields:

  • 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