Home
API reference
Platform API reference
Platform API
Translation sets
Update translation set

Update translation set

patch/v1/operations/translationsets/{translationSetId}
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 translation set

Update a translation set by either adding new mappings or changing or deleting existing mappings. It may be helpful to use the Get translation set endpoint first to review current mappings before updating.

Whether adding, updating, or deleting mappings, the translations array in the request body should include all current mappings with their respective fromValueId and toValueId. Then:

  • To add mappings, add entries for new mappings with both their fromValueId and toValueId properties specified.
  • To update existing mappings, include both the fromValueId and toValueId, whether you want to retain the value as-is or change it to the new value.
  • To delete values, exclude the current mapping from the translations array altogether.

This endpoint allows you to update one translation set at a time.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsets/{translationSetId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "name": "string",
8
  "fromValueSetId": "76844187-ad05-41ea-a530-4e46b8701250",
9
  "toValueSetId": "462a3a3c-7aa0-4f81-bdb7-9daf9a8a7f2b",
10
  "translations": [
11
    {
12
      "toValueId": "3f954e50-cf5a-47c2-bf36-b9b4c78e515f",
13
      "fromValueId": "d27ff859-f1ef-4d7d-be2b-6ac0f43abb0c"
14
    }
15
  ],
16
  "isCaseSensitive": true
17
}'

Path Parameters

  • translationSetId
    required, string

    Contains the unique identifier for the translation set.

Request Body Schema

  • name
    string

    Contains the human-readable name of the asset.

  • fromValueSetId
    string

    Identifies the value set you to translate FROM.

    Format: uuid
  • toValueSetId
    string

    Identifies the value set you want to translate TO.

    Format: uuid
  • translations
    Array of object

    Contains the list of mapped value pairs by their respective unique identifiers.

    • toValueId
      string

      Specifies the unique identifier of a value in the TO value set.

      Format: uuid
    • fromValueId
      string

      Specifies the unique identifier of a value in the FROM value set.

      Format: uuid
  • isCaseSensitive
    boolean

    Indicates if the translation set is case sensitive or not.

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