GET /data_classification/dsm_event_mappings/{dsm_event_mapping_id}

Retrieves a DSM event mapping based on the supplied DSM event mapping ID.

Retrieves a DSM event mapping based on the supplied DSM event mapping ID.

Table 1. GET /data_classification/dsm_event_mappings/{dsm_event_mapping_id} resource details
MIME Type

application/json

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

dsm_event_mapping_id

path

Required

Number (Integer)

text/plain

Required - The ID of the DSM event mapping.

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

200

The requested DSM event mapping was retrieved.

404

1002

The requested DSM event mapping was not found.

500

1020

An error occurred during the attempt to retrieve the DSM event mapping.

Response Description

A DSM event mapping that contains the following fields:
  • id - Number - The ID of the DSM event mapping.
  • log_source_type_id - Number - The ID of the Log Source Type this DSM event mapping resource is associated with.
  • log_source_event_id - String - The primary identifying value parsed from an event to be used to look up the corresponding QID record.
  • log_source_event_category - String - The secondary identifying value parsed from an event to be used to look up the corresponding QID record.
  • custom_event - Boolean - Flag to identify if the DSM event mapping is system provided (custom_event=false) or user-provided (custom_event=true).
  • qid_record_id - Number - The ID of the QID record to which this DSM event mapping provides a mapping.
  • uuid - String - The uuid of the DSM event mapping.

Response Sample


{
    "custom_event": true,
    "id": 42,
    "log_source_event_category": "String",
    "log_source_event_id": "String",
    "log_source_type_id": 42,
    "qid_record_id": 42,
    "uuid": "String"
}