Restore translation set

post/v1/operations/translationsets/{translationSetId}/restore

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;

Restore translation set

Restore a translation set to a previously used version. You can select which version to restore, whether going backward or forward.

To preview changes, set the dryRun query parameter to true. Otherwise, set the dryRun query parameter to false or omit altogether to immediately apply the restored version to the linked subscription.

Can’t restore an active or non-existent version

This endpoint results in an error if you try to restore to an already active version or a version that doesn’t exist.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsets/{translationSetId}/restore' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "version": 1
8
}'

Path Parameters

translationSetId
required, string
Contains the unique identifier for the translation set.

Query Parameters

dryRun
boolean
Specifies whether the restore will be previewed or executed. Set to true to run a preview of restoring the asset; this keeps the asset at its current version. Set to false (or omit) to restore the version.

Request Body Schema

version
number
Specifies the version of the translation set to restore.

Response fields and example

Example payload generated from schema

1
{
2
  "previous": {
3
    "createdAt": "2024-04-25T18:17:16.719Z",
4
    "createdBy": {
5
      "id": 0,
6
      "name": "string"
7
    },
8
    "updatedAt": "2024-04-25T18:17:16.719Z",
9
    "updatedBy": {
10
      "id": 0,
11
      "name": "string"
12
    },
13
    "deletedAt": "2024-04-25T18:17:16.719Z",
14
    "deletedBy": {
15
      "id": 0,
16
      "name": "string"
17
    },
18
    "environment": {
19
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
20
    },
21
    "organization": {
22
      "id": 122,
23
      "name": "string"
24
    },
25
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
26
    "version": 2,
27
    "name": "string",
28
    "toValueSet": {
29
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
30
      "name": "string"
31
    },
32
    "fromValueSet": {
33
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
34
      "name": "string"
35
    },
36
    "isCaseSensitive": true,
37
    "usage": [
38
      {
39
        "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
40
        "direction": "to-from"
41
      }
42
    ],
43
    "promotionAssociations": [
44
      {
45
        "organization": {
46
          "id": 122,
47
          "name": "string"
48
        },
49
        "fromAsset": {
50
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
51
          "environment": {
52
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
53
          },
54
          "type": "configModifier",
55
          "latestVersion": 0
56
        },
57
        "toAsset": {
58
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
59
          "environment": {
60
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
61
          },
62
          "type": "configModifier",
63
          "latestVersion": 0,
64
          "outOfDate": true
65
        },
66
        "createdAt": "2024-04-25T18:17:16.719Z",
67
        "createdBy": {
68
          "id": 0,
69
          "name": "string"
70
        },
71
        "updatedAt": "2024-04-25T18:17:16.719Z",
72
        "updatedBy": {
73
          "id": 0,
74
          "name": "string"
75
        },
76
        "deletedAt": "2024-04-25T18:17:16.719Z",
77
        "deletedBy": {
78
          "id": 0,
79
          "name": "string"
80
        }
81
      }
82
    ]
83
  },
84
  "current": {
85
    "createdAt": "2024-04-25T18:17:16.719Z",
86
    "createdBy": {
87
      "id": 0,
88
      "name": "string"
89
    },
90
    "updatedAt": "2024-04-25T18:17:16.719Z",
91
    "updatedBy": {
92
      "id": 0,
93
      "name": "string"
94
    },
95
    "deletedAt": "2024-04-25T18:17:16.719Z",
96
    "deletedBy": {
97
      "id": 0,
98
      "name": "string"
99
    },
100
    "environment": {
101
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
102
    },
103
    "organization": {
104
      "id": 122,
105
      "name": "string"
106
    },
107
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
108
    "version": 2,
109
    "name": "string",
110
    "toValueSet": {
111
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
112
      "name": "string"
113
    },
114
    "fromValueSet": {
115
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
116
      "name": "string"
117
    },
118
    "isCaseSensitive": true,
119
    "usage": [
120
      {
121
        "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
122
        "direction": "to-from"
123
      }
124
    ],
125
    "promotionAssociations": [
126
      {
127
        "organization": {
128
          "id": 122,
129
          "name": "string"
130
        },
131
        "fromAsset": {
132
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
133
          "environment": {
134
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
135
          },
136
          "type": "configModifier",
137
          "latestVersion": 0
138
        },
139
        "toAsset": {
140
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
141
          "environment": {
142
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
143
          },
144
          "type": "configModifier",
145
          "latestVersion": 0,
146
          "outOfDate": true
147
        },
148
        "createdAt": "2024-04-25T18:17:16.719Z",
149
        "createdBy": {
150
          "id": 0,
151
          "name": "string"
152
        },
153
        "updatedAt": "2024-04-25T18:17:16.719Z",
154
        "updatedBy": {
155
          "id": 0,
156
          "name": "string"
157
        },
158
        "deletedAt": "2024-04-25T18:17:16.719Z",
159
        "deletedBy": {
160
          "id": 0,
161
          "name": "string"
162
        }
163
      }
164
    ]
165
  },
166
  "dryRun": true
167
}

previous
object
- 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.
- 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.
- id
  string
  Contains the unique identifier of the asset.
  Format: uuid
- version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
- name
  string
  Contains the human-readable name of the asset.
- toValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
- fromValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
- isCaseSensitive
  boolean
  Indicates if the translation set is case sensitive or not.
- usage
  Array of object
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  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
- promotionAssociations
  Array of object
  Contains a list of promotions associated with this asset.
  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.
  fromAsset
  object
  Describes the original asset that was created in staging and promoted to production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the original asset in staging. This may vary from the version number in production. A different version number may indicate you need to re-promote the asset to production.
  toAsset
  object
  Describes the promoted asset that can be used or linked to subscriptions in production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the promoted asset in production. This may vary from the version number in staging. A different version number may indicate you need to re-promote the staging asset to production.
  outOfDate
  boolean
  Indicates whether the version of the promoted asset in production is different from the version of the original asset in staging.
  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.
current
object
- 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.
- 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.
- id
  string
  Contains the unique identifier of the asset.
  Format: uuid
- version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
- name
  string
  Contains the human-readable name of the asset.
- toValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
- fromValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
- isCaseSensitive
  boolean
  Indicates if the translation set is case sensitive or not.
- usage
  Array of object
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  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
- promotionAssociations
  Array of object
  Contains a list of promotions associated with this asset.
  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.
  fromAsset
  object
  Describes the original asset that was created in staging and promoted to production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the original asset in staging. This may vary from the version number in production. A different version number may indicate you need to re-promote the asset to production.
  toAsset
  object
  Describes the promoted asset that can be used or linked to subscriptions in production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the promoted asset in production. This may vary from the version number in staging. A different version number may indicate you need to re-promote the staging asset to production.
  outOfDate
  boolean
  Indicates whether the version of the promoted asset in production is different from the version of the original asset in staging.
  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.
dryRun
boolean

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.