GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_definition

Retrieve dsm parameter definitions.

Table 1. GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_definition resource details
MIME Type
application/json

Table 2. GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_definition request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
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.
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.

Table 3. GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_definition response codes
HTTP Response Code	Unique Code	Description
201		The dsm parameter definition was retrieved successfully.
500	1009	An error occurred while attempting to retrieve dsm parameter definitions.

Response Description

The result will have a list of the following fields:

id - The id of the dsm parameter definition.
internal_name - String - The name of the dsm parameter definition.
name_localization_key - String - The localized name of the dsm parameter definition.
description_localization_key - String - The localized description of the dsm parameter definition.
type - String - The type of the dsm parameter definition.
default_value - The default value of the dsm parameter definition.
sort_index - Long - The Sort Index of the dsm parameter definition.
min_length - Long - The min length of the values of the dsm parameter definition.
max_length - Long - The min length of the values of the dsm parameter definition.
min_value - Long - The min value of the values of the dsm parameter definition
max_value - Long - The min value of the values of the dsm parameter definition
pattern - Sring - The pattern of the values of the dsm parameter definition.
pattern_description - String - The description of the pattern of the values of the dsm parameter definition.

Response Sample


[
    {
        "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"
    }
]