Home
API reference
Platform API reference
Platform API
Translation sets
Update link

Update link

put/v1/operations/translationsetlinks{translationSetLinkId}
Page View

Translation set endpoints allow you to review and manage value sets, translation sets, and related translation set links.

A value set is a list of values (e.g., LOINC, SNOMED, or a custom code set) that should be translated during the process of data exchange.

A translation set contains two value sets: one for incoming values and one for outgoing values between systems. A translation set also defines how those values should map to each other. Learn about translation sets.

A translation set link defines where the translation set should be applied in log processing for a specific subscription.

Anyone in a Redox organization can view translation sets and related value sets or links, but you must be assigned to an engineer or support role to update or delete them.

You can:

  • retrieve a list of value sets by environment or organization;
  • retrieve a list of translation sets by environment or organization;
  • create, update, or delete value sets;
  • create, update, or delete translation sets or links;
  • create, update, or delete a value in a value set; or
  • create or delete a translation in a translation set;

Update link

Update an existing link for a translation set within a Redox organization. You must use the correct ID to update the settings.

This endpoint overwrites any existing settings of a translation set link with the details in the request body.

You can update one translation set link at a time.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsetlinks{translationSetLinkId}' \
2
--request PUT \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "source": {
8
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
9
  },
10
  "destination": {
11
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
12
  },
13
  "dataModel": "PatientAdmin",
14
  "direction": "to-from",
15
  "processingLocation": "source-request",
16
  "paths": [
17
    {
18
      "dataType": "string",
19
      "title": "Custom Path",
20
      "path": "$.Allergies[*].Type.Code"
21
    }
22
  ]
23
}'

Path Parameters

  • Contains the unique identifier of the translation set link.

Request Body Schema

  • source
    object

    Specifies the source of the subscription that an asset is or should be linked to.

    • id
      required, string

      Contains the unique identifier of the source.

      Format: uuid
  • destination
    object

    Specifies the destination of the subscription that an asset is or should be linked to.

    • id
      required, string

      Contains the unique identifier of the destination.

      Format: uuid
  • dataModel
    string

    Specifies the Redox data model that the link applies to or should apply to.

  • direction
    string

    Indicates the direction in which the translation set is or should be linked. This can be either from-to (translates a "from" value into a "to" value), or to-from (tranlates a "to" value into a "from" value).

    Possible Values: from-to, to-from
  • processingLocation
    string

    Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.

    Possible Values: source-request, destination-request, source-response, destination-response
  • paths
    Array of object

    Lists the field paths linked to a translation set. These paths must be unique on the path property.

    • dataType
      string

      Describes the format of the data found at the path location.

    • title
      string

      Specifies a human-readable title for the field path.

    • path
      string

      Specifies the path in a message to the location of the data to be translated. The path must always start with a $ to be considered valid.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
7
  }
8
}
  • 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 id of the created or modified asset.

    • id
      string

      Contains the unique identifier of the asset.

      Format: uuid