Home
API reference
Platform API
Platform API
Translation sets
Get link

Get link

get/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;

Get link

Retrieve one related link for an existing translation set based on its unique ID. Links indicate where the translation set is applied during log processing.

Request parameters

cURL request example

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

Path Parameters

  • Contains the unique identifier of the translation set link.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "translationSetLink": {
7
      "environment": {
8
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
9
      },
10
      "organization": {
11
        "id": 122,
12
        "name": "string"
13
      },
14
      "createdAt": "2024-04-25T18:17:16.719Z",
15
      "createdBy": {
16
        "id": 0,
17
        "name": "string"
18
      },
19
      "updatedAt": "2024-04-25T18:17:16.719Z",
20
      "updatedBy": {
21
        "id": 0,
22
        "name": "string"
23
      },
24
      "deletedAt": "2024-04-25T18:17:16.719Z",
25
      "deletedBy": {
26
        "id": 0,
27
        "name": "string"
28
      },
29
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
30
      "dataModel": "PatientAdmin",
31
      "destination": {
32
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
33
      },
34
      "direction": "to-from",
35
      "connectingOrganization": {
36
        "id": 122
37
      },
38
      "paths": [
39
        {
40
          "dataType": "string",
41
          "title": "Custom Path",
42
          "path": "$.Allergies[*].Type.Code"
43
        }
44
      ],
45
      "processingLocation": "source-request",
46
      "translationSet": {
47
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
48
      },
49
      "version": "1.0.0"
50
    }
51
  }
52
}
  • 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 details about the requested translation set link.

      • environment
        object

        Describes the Redox environment that the asset belongs to.

        • id
          string

          Contains the unique identifier of the Redox environment.

          Format: uuid
      • organization
        object

        Describes the Redox organization that the asset belongs to.

        • id
          number

          Contains the unique identifier of the Redox organization.

        • name
          nullable, string

          Contains the human-readable name of the Redox organization.

      • createdAt
        string

        Displays the date and time that the asset was originally created in ISO 8601 format.

      • createdBy
        object

        Contains the metadata about the user who created the asset.

        • id
          number

          Contains the unique identifier of the user.

        • name
          nullable, string

          Displays the user's full name.

      • updatedAt
        string

        Displays the date and time that the asset was last updated in ISO 8601 format.

      • updatedBy
        object

        Contains the metadata about the user who last updated the asset.

        • id
          number

          Contains the unique identifier of the user.

        • name
          nullable, string

          Displays the user's full name.

      • deletedAt
        nullable, string

        Displays the date and time that the asset was deleted. Returns a null value if the asset hasn't been deleted.

      • deletedBy
        nullable, object

        Contains the metadata about the user who deleted the asset.

        • id
          number

          Contains the unique identifier of the user.

        • name
          nullable, string

          Displays the user's full name.

      • id
        string

        Contains the unique identifier of the link for a specified asset.

        Format: uuid
      • dataModel
        string

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

      • 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
      • 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
      • connectingOrganization
        object

        Specifies the organization at the other side of the subscription that an asset is or should be linked to.

        • id
          required, number

          Contains the unique identifier of the Redox organization.

      • 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.

      • 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
      • translationSet
        object

        Contains metadata about the linked translation set.

        • id
          string

          Contains the unique identifier of the asset.

          Format: uuid
      • version
        string

        Specifies the version of the translation set link. Right now this will always be '1.0.0'.

        Value: 1.0.0