Skip to main content

Configuration

The Configuration APIs are used to retrieve information about search fields and description groups. The results can be applied within the search APIs.

Get all globally available search-fields​

Endpoint: /publicapi/global/configuration/search-fields

Method: GET

Content-Type: application/json

Response​

The response will produce an array of all available search fields within the environment, which can then be used in the search APIs.

{
  "data": [
    {
      "name": "string",
      "label": "string",
      "isGlobal": true,
      "isNumeric": true,
      "isRange": true,
      "isText": true,
      "isDate": true,
      "order": 0
    }
  ]
}

Get a list of all available description-groups​

Endpoint: /publicapi/global/configuration/description-groups

Method: GET

Content-Type: application/json

Response​

The response will provide a list of description groups, enabling their use in the search APIs to perform targeted searches within a specific part of the environment.

{
  "data": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}