ON THIS PAGE
POST /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters/{id}
SUMMARY Update a dsm parameter by id.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
The ID of the dsm parameter to retrieve. |
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. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
dsm_paramaters |
Object |
application/json |
null |
{ "dsm_parameter_definition_id": 42, "event_collector_id": 42, "id": 42, "sensor_device_type_id": 42, "value": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
The log source type was created successfully. |
|
404 |
1026 |
The dsm parameter ID was not found. |
422 |
1021 |
The provided dsm_parameter_definition_id is not valid. |
422 |
1022 |
The provided event_collector_id is not valid. |
422 |
1023 |
The provided sensor_device_type_id is not valid. |
422 |
1024 |
The provided value is not valid. |
422 |
1025 |
A record with the same (dsm_parameter_definition_id, event_collector_id, sensor_device_type_id) already exists. |
500 |
1027 |
An error occurred during the attempt to update the dsm parameter. |
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 - 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" }