Home
API reference
Platform API
Platform API
Configs
Create source link

Create source link

post/v1/operations/configLinks/sources/{sourceId}
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.

Create source link

Link a base config to the specified source. You can link the same base config to multiple sources.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/configLinks/sources/{sourceId}' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "configId": "f84d602d-7449-4a13-b9a4-8688cae85726",
8
  "processingLocation": "request",
9
  "version": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
10
  "dataModel": "Provider",
11
  "eventType": "New"
12
}'

Path Parameters

  • sourceId
    required, string

    Displays the unique identifier of a source within a given environment.

Request Body Schema

    Defines the metadata for creating a new base config link.

  • configId
    required, string

    Displays the unique identifier of the base config being linked to the source.

    Format: uuid
  • version
    required, string

    Specifies the version of the base config to use. If not provided, uses the same value as configId.

    Format: uuid
  • dataModel
    required, string

    Identifies the Redox data model that this config link applies to.

  • processingLocation
    string

    Specifies where the base config should be applied, whether to the request or response side of the data exchange. If not provided, the default is request. The processing location can't be changed once the base config link is created.

    Possible Values: request, response
  • eventType
    nullable, string

    Specifies the event types of the given Redox data model that the link applies to. If null, the config is linked to all event types of the data model.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "configLink": {
7
      "id": "dc5d2a43-df19-459c-b14f-450584ce1c55",
8
      "configId": "f84d602d-7449-4a13-b9a4-8688cae85726",
9
      "processingLocation": "request",
10
      "version": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11
      "dataModel": "Provider",
12
      "eventType": "New"
13
    }
14
  }
15
}
  • 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 the details about the specified base config link.

    • Contains a base config link and its related details.

      • id
        string

        Displays the unique identifier of the link between the source and base config.

        Format: uuid
      • configId
        string

        Displays the unique identifier of the base config being linked to the source.

        Format: uuid
      • processingLocation
        string

        Indicates whether the base config applies to request or response processing.

        Possible Values: request, response
      • version
        string

        Specifies the version of the base config being used.

        Format: uuid
      • dataModel
        string

        Identifies the Redox data model that this config link applies to.

      • eventType
        nullable, string

        Specifies the event types of the given Redox data model that the link applies to. If null, the config is linked to all event types of the data model.