Remote Configuration

Our Remote Config is a simple configuration key-value store. Based on a key, different values and value types can be saved here. Furthermore every entry can be contain a specific scope, this means that configurations can only be made available to certain user groups or clients.

Because the fulfillmenttools platform is not communicating with the Remote Config, only simple client configs should be saved in here.

Create / Update

Alter Remote Config

Create a new remote configuration

POST/api/remoteconfigs

Body

application/json

key*string

unique business key of this entity

Example: "PICKING_SHOW_NEW_SCAN_VIEW"

scopesarray of RemoteConfigurationScopeForCreation (object)

valueType*RemoteConfigurationValueType (enum)

BOOLEANSTRINGJSONNUMBERINT

value*one of

stringintegernumberbooleanobject

groups*array of string

Response

200401403

Created entity in the body.

Body

application/json

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('/api/remoteconfigs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "PICKING_SHOW_NEW_SCAN_VIEW",
      "value": "text",
      "valueType": "BOOLEAN",
      "groups": [
        "INVENTORY"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "valueType": "BOOLEAN",
  "value": "text",
  "groups": [
    "INVENTORY"
  ],
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ]
}

Add Scope

Read

Read all

Get all remote configurations

GET/api/remoteconfigs

Query parameters

Response

200401403404

Central RemoteConfiguration

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/remoteconfigs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Read single

Delete

Delete Remote Config

Delete scope

Example JSON

{
    "id": "REMOTE-CONFIG-ID-001",
    "key": "SHOW_RETURN_SECTION",
    "value": false,
    "valueType": "BOOLEAN",
    "groups": [
        "FULFILLMENT",
        "BACKOFFICE"
    ],
    "scopes": [
        {
            "id": "SCOPE-ID-0001",
            "facilityRefs": [
                "FACILITY-ID-001"
            ],
            "userRefs": [
                "USER-ID-001",
                "USER-ID-003"
            ]
        }
    ],
    "created": "2023-01-10T09:32:00.000+00:00",
    "lastModified": "2023-01-10T10:54:00.000+00:00",
    "version": 7
}

JSON field descriptions

key

The unique key that identifies the Remote Config entry, this can be freely chosen at entry creation.

value & valueType

The value of the key-value pair. With the valueType, the clients can identify the technical type of the value field for parsing.

groups

At creation every entry can (but it doesn't have to) have one or multiple groups. This are only simple strings that can defined free. If a client call later the API, this group-strings can be uses as filter. This way, every client gets only the configurations that are important to them.

scopes

Defines a specific scope where the configuration is available. It is possible to add different facilities and/or users. The facility and user declarations AND-linked.

Example:

"scopes": [{
    "id": "SCOPE-1234",
    "facilityRefs": [
        "FACILITY-4711",
        "FACILITY-4712"
    ],
    "userRefs": [
        "USER-40",
        "USER-43"
    ]
}]

In the example above the configuration will be only returned for user USER-40 or USER-43 that are working in facility FACILITY-4711 or FACILITY-4712. All other user and facility combinations don't get this Remote Config entry.