ON THIS PAGE
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters
SUMMARY Retrieve dsm parameters.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
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. |
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. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The dsm parameters retrieved successfully. |
|
500 |
1019 |
An error occurred while attempting to retrieve dsm parameters. |
Response Description
- 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_id - Long - The id of 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" } ]