ON THIS PAGE
GET /data_classification/qid_records/{qid_record_id}
SUMMARY Retrieves a QID record that is based on the supplied qid_record_id.
Retrieves a QID record that is based on the supplied qid_record_id.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
qid_record_id |
path |
Required |
Number (Integer) |
text/plain |
Required - the ID of the QID record. |
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 QID record was retrieved. |
|
404 |
1002 |
The requested QID record was not found. |
422 |
1005 |
qid_record_id must be a positive integer. |
500 |
1020 |
An error occurred during the attempt to retrieve the QID record. |
Response Description
- 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
{ "id": 63998, "qid": 2500001, "name": "spp_portscan: Portscan Detected", "description": "spp_portscan: Portscan Detected", "severity": 4, "low_level_category_id": 1008, "log_source_type_id": null, "uuid": null }