Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /data_classification/qid_records

Retrieves a list of QID records.

Retrieves a list of QID records.

Table 1: GET /data_classification/qid_records Resource Details

MIME Type

application/json

Table 2: GET /data_classification/qid_records Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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/qid_records Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested list of QID records was retrieved.

500

1020

An error occurred during the attempt to retrieve the list of QID records.

Response Description

A list of QID records. A QID record contains the following fields:

  • id - Number - The ID of the QID record.

  • qid - Number - The QID of the QID record.

  • name - String - The name of the QID record.

  • description - String - The description of the QID record.

  • severity - Number - The severity of the QID record.

  • low_level_category_id - Number - The low level category ID of the QID record.

  • log_source_type_id - Number - A placeholder with null value to ensure data structure consistency among endpoints.

  • uuid - String - The uuid of the QID record.

Response Sample