ON THIS PAGE
PATCH /config/event_sources/log_source_management/ log_source_types/dsm_parameter_configuration/ dsm_parameter_allowed_values
Create new dsm parameter allowed values or Update available dsm parameter allowed values. The following fields can be provided in the body of this request, all other dsm parameter allowed value fields will be ignored:
id - Long- The id of the dsm parameter allowed value. If field id exist it considers as an update otherwise it is a create action.
value - String - The value of the dsm parameter allowed value. Cannot be empty. Must be 8192 characters or less.
dsm_parameter_definition_id - Long - The id of the corresponding dsmparameterdefinition.
name - String - The name of the dsm parameter allowed value.
sort_index - Long - the index of the record for sorting.
MIME Type |
|---|
application/json |
Parameter |
Type |
Optionality |
Data Type |
MIME Type |
Description |
|---|---|---|---|---|---|
filter |
header |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
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 |
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 _paramater _allowed_values |
Array<Object> |
application/json |
null |
[ { "dsm_parameter_definition_id": 42, "id": 42, "name": "String", "sort_index": 42, "value": "String" } ] |
HTTP Response Code |
Unique Code |
Description |
|---|---|---|
207 |
The dsm parameter allowed values were created/updated successfully. |
|
404 |
1055 |
The dsm parameter allowed value ID was not found. |
422 |
1051 |
The provided dsm_parameter_definition_id is not valid. |
422 |
1052 |
The provided name is not valid. |
422 |
1053 |
The provided value is not valid. |
422 |
1054 |
The provided sort index is not valid. |
422 |
1056 |
The record already exists. |
500 |
1050 |
An error occurred while attempting to create the dsm parameter allowed value. |
Response Description
A list of the newly created or updated dsm parameters which will have the following fields:
id - Long- The id of the created/updated 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.
name - String - The name of the dsm parameter allowed value.
sort_index - Long - the index of the record for sorting.
Response Sample
[ { "dsm_parameter_definition_id": 42, "id": 42, "name": "String", "sort_index": 42, "value": "String" } ]