Remote configuration endpoints

List remote configs

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

facilityIdstringOptional

facility to filter to

groupsstring[]Optional

groups to filter to

userIdstringOptional

userId to filter to

Responses

200

Central RemoteConfiguration

application/json

RemoteConfigurations

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/remoteconfigs

HTTPcURLJavaScriptPython

GET /api/remoteconfigs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "remoteConfigurations": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Create remote config

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

RemoteConfigurationForCreation

groupsstring[] · min: 1RequiredExample: INVENTORY

keystringRequired

unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

valueone ofRequired

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

RemoteConfigurationValueType

Possible values:

Responses

200

Created entity in the body.

application/json

RemoteConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/remoteconfigs

HTTPcURLJavaScriptPython

POST /api/remoteconfigs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "groups": [
    "INVENTORY"
  ],
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN"
}

{
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get remote config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to get

Responses

200

Central RemoteConfiguration

application/json

RemoteConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/remoteconfigs/{id}

HTTPcURLJavaScriptPython

GET /api/remoteconfigs/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update remote config

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to change

Body

application/json

RemoteConfigurationForPut

groupsstring[] · min: 1RequiredExample: INVENTORY

valueone ofRequired

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

RemoteConfigurationValueType

Possible values:

versionintegerRequired

Responses

200

Successfully Changed

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

put

/api/remoteconfigs/{id}

HTTPcURLJavaScriptPython

PUT /api/remoteconfigs/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "groups": [
    "INVENTORY"
  ],
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

No content

Create remote config scope

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to change

Body

application/json

AddRemoteConfigurationScopeParameter

remoteConfigVersionnumberRequired

Responses

200

Updated RemoteConfiguration in the body.

application/json

RemoteConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/remoteconfigs/{id}/scopes

HTTPcURLJavaScriptPython

POST /api/remoteconfigs/{id}/scopes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "remoteConfigVersion": 1,
  "scope": {
    "facilityRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "userRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ]
  }
}

{
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update remote config

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to change

Body

application/json

RemoteConfigurationForUpdate

groupsstring[] · min: 1OptionalExample: INVENTORY

valueone ofOptional

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumOptional

RemoteConfigurationValueType

Possible values:

versionintegerRequired

Responses

200

Successfully Changed

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

patch

/api/remoteconfigs/{id}

HTTPcURLJavaScriptPython

PATCH /api/remoteconfigs/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "groups": [
    "INVENTORY"
  ],
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

No content

Delete remote config

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to delete

Responses

200

Successfully Deleted

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

delete

/api/remoteconfigs/{id}

HTTPcURLJavaScriptPython

DELETE /api/remoteconfigs/{id} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete remote config scope

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Reference to the remote config you want to alter

scopeIdstringRequired

Reference to the remote config scope you want to delete

Responses

200

Successfully Deleted

application/json

RemoteConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

delete

/api/remoteconfigs/{id}/scopes/{scopeId}

HTTPcURLJavaScriptPython

DELETE /api/remoteconfigs/{id}/scopes/{scopeId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}