Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /data_classification/qid_records/{qid_record_id}

 

Updates an existing QID record.

Updates an existing QID record.

Table 1: POST /data_classification/qid_records/{qid_record_id} Resource Details

MIME Type

application/json

Table 2: POST /data_classification/qid_records/{qid_record_id} Request Parameter Details

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

header

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: POST /data_classification/qid_records/{qid_record_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

qid_record

Object

application/json

Required - The QID record to be updated, which may contain the following fields:

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

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

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

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

{ "name": "spp_portscan: Portscan Detected", "description": "spp_portscan: Portscan Detected", "severity": 4, "low_level_category_id":1008 }

Table 4: POST /data_classification/qid_records/{qid_record_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The QID record was updated.

404

1002

The requested QID record was not found.

409

1008

The QID record that was provided cannot be updated because it is a system-provided QID.

422

1005

Invalid parameter was provided during the update to the QID record.

500

1020

An error occurred during the attempt to update a QID record.

Response Description

The updated QID record containing 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