Home
API reference
Platform API
Platform API
Translation sets
Get value set

Get value set

get/v1/operations/valuesets/{valueSetId}
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 value set

Retrieve a specific value set based on its unique ID. This could be helpful if you want to view the value set before using, updating, or deleting it.

Request parameters

cURL request example

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

Path Parameters

  • valueSetId
    required, string

    Contains the unique identifier of the value set.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "valueSet": {
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
      "name": "string",
31
      "values": [
32
        {
33
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
34
          "value": "5792-7"
35
        }
36
      ],
37
      "valueSetUsage": [
38
        {
39
          "translationSetId": "6531111b-777c-4c97-a077-8ddaea0830c4",
40
          "translationSetName": "string"
41
        }
42
      ]
43
    }
44
  }
45
}
  • 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 value set.

    • valueSet
      object
      • 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 asset.

        Format: uuid
      • name
        string

        Contains the human-readable name of the asset.

      • values
        Array of object
        • id
          string

          Contains the unique identifier of the asset.

          Format: uuid
        • value
          string

          Contains the actual string value data.

      • valueSetUsage
        Array of object
        • translationSetId
          string

          Contains the unique identifier of the asset.

          Format: uuid
        • translationSetName
          string

          Contains the human-readable name of the asset.