Home
API reference
Platform API
Platform API
Configs
Get configs

Get configs

get/v1/operations/configs
Page View

Config endpoints allow you to review metadata of available Redox base configs and related source links. Learn about mapping operations.

Base configs can be linked to sources within your Redox organization to convert a payload from a one data format to the appropriate Redox data model or FHIR® resource.

Anyone in a Redox organization can view metadata of base configs and source links. However, only a Redoxer can view or modify the content of base configs, and only a user assigned to an engineer or support role can manage source links.

You can:

  • retrieve a list of available base configs;
  • retrieve a list of links attached to a source;
  • create base config links to sources;
  • update base config links to sources; or
  • delete base config links to sources.

Get configs

Retrieve metadata of all available Redox base configs.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/configs' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Query Parameters

  • sourceOrDestination
    string

    Indicates whether the base config is applied to the source or destination side of the exchange.

  • dataModel
    string

    Describes which data model the base config is built from. In other words, this is the data model that serves as the starting point for the base config.

  • translatedDataFormat
    string

    Describes the format of the data, depending on whether the base config is applied at the source or destination. For source base configs, this is the format of the inbound data before applying the base config. For destination base configs, this is the format that the data is translated to after applying the base config.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "configs": [
7
      {
8
        "id": "f3a7e122-8e10-4e40-b8d2-6151a2e5583d",
9
        "sourceOrDestination": "source",
10
        "dataModel": "PatientAdmin",
11
        "name": "Redox Patient Admin Config",
12
        "translatedDataFormat": "JSON",
13
        "latestVersion": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14
      }
15
    ]
16
  }
17
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Contains an array of base configs.

    • configs
      Array of object
      • id
        string

        Contains the unique identifier of the base config.

      • sourceOrDestination
        string

        Indicates whether the base config is applied to the source or destination side of the exchange.

        Possible Values: source, destination
      • dataModel
        string

        Describes which data model the base config is built from. In other words, this is the data model that serves as the starting point for the base config.

      • name
        string

        Displays the human-readable name of the base config.

      • translatedDataFormat
        string

        Describes the format of the data, depending on whether the base config is applied at the source or destination. For source base configs, this is the format of the inbound data before applying the base config. For destination base configs, this is the format that the data is translated to after applying the base config.

        Possible Values: HL7v2, JSON, X12, X12v2, XML Builder, XML (to JSON)
      • latestVersion
        string

        Contains the unique identifier of the latest published version of this base config.

        Format: uuid