Application Settings
Operations related to application settings
Returns a paginated list of all application settings with optional filtering. The response includes the ID, key, and JSON value for each setting.
Use format: Token <your_token>
Filter settings by key (contains search)
Page number for pagination
1Number of items per page
10Successful operation
Total number of settings
25URL to the next page of results
/api/v1/settings/application_settings/?page=2URL to the previous page of results
GET /api/v1/oms/settings/application_settings/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful operation
{
"count": 25,
"next": "/api/v1/settings/application_settings/?page=2",
"previous": null,
"results": [
{
"id": 1,
"key": "GEOCODE_PROVIDER_SETTINGS",
"json_value": {
"provider": "google",
"api_key": "example_api_key",
"url": "https://maps.googleapis.com/maps/api/geocode/json"
}
}
]
}Creates a new application setting with the provided key and value. The value will be validated according to the setting type using registered serializers.
If the setting key already exists, the operation will fail.
Use format: Token <your_token>
The key of the application setting. Must be one of the predefined ApplicationSettingsKey enum values.
GEOCODE_PROVIDER_SETTINGSThe value of the application setting, structure depends on the key. This is a dynamic object that follows the schema defined for each setting key.
{"provider":"google","api_key":"example_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}Setting created successfully
Bad request - validation error
POST /api/v1/oms/settings/application_settings/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 156
{
"key": "GEOCODE_PROVIDER_SETTINGS",
"json_value": {
"provider": "google",
"api_key": "example_api_key",
"url": "https://maps.googleapis.com/maps/api/geocode/json"
}
}No content
Returns a specific application setting by ID. The response includes the ID, key, and JSON value for the setting.
Note: For security reasons, sensitive information like passwords in the OMNITRON_CLIENT_SETTINGS are masked with asterisks.
Use format: Token <your_token>
The ID of the application setting
Successful operation
Unique identifier for the application setting
1The key of the application setting
GEOCODE_PROVIDER_SETTINGSThe value of the application setting, structure depends on the key. This is a dynamic object that follows the schema defined for each setting key.
{"provider":"google","api_key":"example_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}Setting not found
GET /api/v1/oms/settings/application_settings/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"id": 1,
"key": "GEOCODE_PROVIDER_SETTINGS",
"json_value": {
"provider": "google",
"api_key": "example_api_key",
"url": "https://maps.googleapis.com/maps/api/geocode/json"
}
}Updates an existing application setting value with validation. The key cannot be changed, only the json_value can be updated.
The value is validated according to the setting type using registered serializers. If the update is successful, a 200 OK response is returned with no body.
Use format: Token <your_token>
The ID of the application setting
The new value of the application setting, structure depends on the key. This is a dynamic object that follows the schema defined for each setting key.
{"provider":"google","api_key":"updated_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}Setting updated successfully
No content
Bad request - validation error
Setting not found
PUT /api/v1/oms/settings/application_settings/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 118
{
"json_value": {
"provider": "google",
"api_key": "new_api_key",
"url": "https://maps.googleapis.com/maps/api/geocode/json"
}
}No content
Returns the field information for a specific setting key. This can be used to build dynamic forms for updating settings.
The response includes the field names, types, validation rules, and other metadata that can be used to construct a UI for editing the setting.
Use format: Token <your_token>
The key of the application setting
Successful operation
Field information for the requested setting
{"fields":{"provider":{"type":"string","required":true,"choices":["google","mapbox","openstreetmap"]},"api_key":{"type":"string","required":true},"url":{"type":"string","required":true,"format":"uri"}}}Bad request - validation error
GET /api/v1/oms/settings/application_settings/settings_fields/?settings_key=GEOCODE_PROVIDER_SETTINGS HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"fields": {
"provider": {
"type": "string",
"required": true,
"choices": [
"google",
"mapbox",
"openstreetmap"
]
},
"api_key": {
"type": "string",
"required": true
},
"url": {
"type": "string",
"required": true,
"format": "uri"
}
}
}Last updated
Was this helpful?

