GET /config/event_sources/log_source_management/log_source_types/dsm_parameters/{id}

Retrieve a dsm parameter by id.

Table 1. GET /config/event_sources/log_source_management/log_source_types/dsm_parameters/{id} resource details
MIME Type
application/json

Table 2. GET /config/event_sources/log_source_management/log_source_types/dsm_parameters/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	The ID of the dsm parameter to retrieve.
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 /config/event_sources/log_source_management/log_source_types/dsm_parameters/{id} response codes
HTTP Response Code	Unique Code	Description
200		The dsm parameter retrieved successfully.
404	1006	The dsm parameter ID was not found.
500	1020	An error occurred during the attempt to retrieve the dsm parameter.

Response Description

The result will have a list of the following fields:

id - The id of the created dsm parameter.
value - String - The value of the dsm parameter. Cannot be empty. Must be 8192 characters or less.
dsm_parameter_definition - Long - The corresponding dsmparameterdefinition.
sensor_device_type_id - Long - The id of the corresponding sensordevicetype.
event_collector_id - Long - The id of the corresponding eventcollector component.

Response Sample


{
    "dsm_parameter_definition": {
        "allowed_values": [
            {
                "dsm_parameter_definition_id": 42,
                "id": 42,
                "name": "String",
                "sort_index": 42,
                "value": "String"
            }
        ],
        "default_value": "String",
        "description_localization_key": "String",
        "id": 42,
        "internal_name": "String",
        "max_length": 42,
        "max_value": 42,
        "min_length": 42,
        "min_value": 42,
        "name_localization_key": "String",
        "pattern": "String",
        "pattern_description": "String",
        "sort_index": 42,
        "type": "String"
    },
    "event_collector_id": 42,
    "id": 42,
    "sensor_device_type_id": 42,
    "value": "String"
}