Application Settings

Operations related to application settings

List application settings

get

Returns a paginated list of all application settings with optional filtering. The response includes the ID, key, and JSON value for each setting.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

keystringOptional

Filter settings by key (contains search)

pageintegerOptional

Page number for pagination

Default: 1

page_sizeintegerOptional

Number of items per page

Default: 10

Responses

200

Successful operation

application/json

countintegerOptional

Total number of settings

Example: 25

nextstring · nullableOptional

URL to the next page of results

Example: /api/v1/settings/application_settings/?page=2

previousstring · nullableOptional

URL to the previous page of results

get/settings/application_settings/

GET /api/v1/oms/settings/application_settings/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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

Create a new application setting

post

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.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Body

keystringRequired

The key of the application setting. Must be one of the predefined ApplicationSettingsKey enum values.

Example: GEOCODE_PROVIDER_SETTINGS

json_valueobjectRequired

The value of the application setting, structure depends on the key. This is a dynamic object that follows the schema defined for each setting key.

Example: {"provider":"google","api_key":"example_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}

Responses

201

Setting created successfully

400

Bad request - validation error

application/json

post/settings/application_settings/

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

Get a specific application setting

get

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.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idinteger · int64Required

The ID of the application setting

Responses

200

Successful operation

application/json

idinteger · int64Required

Unique identifier for the application setting

Example: 1

keystringRequired

The key of the application setting

Example: GEOCODE_PROVIDER_SETTINGS

json_valueobjectRequired

The value of the application setting, structure depends on the key. This is a dynamic object that follows the schema defined for each setting key.

Example: {"provider":"google","api_key":"example_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}

404

Setting not found

get/settings/application_settings/{id}/

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"
  }
}

Update an application setting

put

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.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idinteger · int64Required

The ID of the application setting

Body

json_valueobjectRequired

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.

Example: {"provider":"google","api_key":"updated_api_key","url":"https://maps.googleapis.com/maps/api/geocode/json"}

Responses

200

Setting updated successfully

No content

400

Bad request - validation error

application/json

404

Setting not found

put/settings/application_settings/{id}/

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

Get field information for a specific setting

get

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.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

settings_keystring · enumRequired

The key of the application setting

Possible values:

Responses

200

Successful operation

application/json

objectOptional

Field information for the requested setting

Example: {"fields":{"provider":{"type":"string","required":true,"choices":["google","mapbox","openstreetmap"]},"api_key":{"type":"string","required":true},"url":{"type":"string","required":true,"format":"uri"}}}

400

Bad request - validation error

application/json

get/settings/application_settings/settings_fields/

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"
    }
  }
}