GET /data_classification/high_level_categories/{high_level_category_id}

Retrieves a high level category based on the supplied high level category ID.

Retrieves a high level category based on the supplied high level category ID.

Table 1. GET /data_classification/high_level_categories/{high_level_category_id} resource details
MIME Type

application/json

Table 2. GET /data_classification/high_level_categories/{high_level_category_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

high_level_category_id

path

Required

Number (Integer)

text/plain

Required - the ID of the high level category.

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/{high_level_category_id} response codes
HTTP Response Code Unique Code Description

200

The requested high level category was retrieved.

404

1002

The requested high level category was not found.

422

1005

High level category ID must be a positive integer.

500

1020

An error occurred during the attempt to retrieve the high level category.

Response Description

A high level category that 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


{
  "id": 19000,
  "name": "Audit",	
  "description": "Audit",
}