Restore config modifier (beta)

post/v1/operations/configmodifiers/{configModifierId}/restore

Page View

Released beta feature

This is a released beta feature. That means it's available to everyone, but we're open to feedback. Talk to your Technical Account Manager to report any issues—or delights!

Config modifier endpoints allow you to review and manage config modifiers and their related links. Learn about config modifiers.

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

You can:

retrieve a list of config modifiers by environment or organization;
create config modifiers or links;
update config modifiers or links; or
delete config modifiers or link.

Restore config modifier (beta)

Restore a config modifier 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/configmodifiers/{configModifierId}/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": 0
8
}'

Path Parameters

configModifierId
required, string
Displays the unique identifier of a config modifier.

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

Response fields and example

Example payload generated from schema

1
{
2
  "previous": {
3
    "id": "3c45db50-6bb2-4cca-b1f9-76125ae9770f",
4
    "version": 0,
5
    "name": "string",
6
    "flavor": "put",
7
    "selector": "$.Patient.Identifiers[*].ID",
8
    "schema": {
9
      "plugin": {
10
        "name": "text",
11
        "action": "upper-case"
12
      }
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
    "environment": {
30
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
31
    },
32
    "organization": {
33
      "id": 122,
34
      "name": "string"
35
    }
36
  },
37
  "current": {
38
    "id": "3c45db50-6bb2-4cca-b1f9-76125ae9770f",
39
    "version": 0,
40
    "name": "string",
41
    "flavor": "put",
42
    "selector": "$.Patient.Identifiers[*].ID",
43
    "schema": {
44
      "plugin": {
45
        "name": "text",
46
        "action": "upper-case"
47
      }
48
    },
49
    "createdAt": "2024-04-25T18:17:16.719Z",
50
    "createdBy": {
51
      "id": 0,
52
      "name": "string"
53
    },
54
    "updatedAt": "2024-04-25T18:17:16.719Z",
55
    "updatedBy": {
56
      "id": 0,
57
      "name": "string"
58
    },
59
    "deletedAt": "2024-04-25T18:17:16.719Z",
60
    "deletedBy": {
61
      "id": 0,
62
      "name": "string"
63
    },
64
    "environment": {
65
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
66
    },
67
    "organization": {
68
      "id": 122,
69
      "name": "string"
70
    }
71
  },
72
  "dryRun": true
73
}

previous
object
Contains a config modifier and its related details.
- id
  string
  Contains the unique identifier of the config modifier.
  Format: uuid
- version
  number
  Indicates the iteration, or version number, of the config modifier. Version numbers start at 1 and increment every time a config modifier is updated.
- name
  string
  Displays the human-readable name of the config modifier.
- flavor
  string
  Indicates the type, or flavor, of config modifier. A put flavor alters data (creates or replaces) in a payload, while a delete flavor removes data from a payload.
  Possible Values: put, delete
- selector
  string
  Indicates the location(s) within the payload that this config modifier will operate on.
- schema
  object
  Required for a put flavor config modifier. Indicates how to build the value at the location the selector specifies.
- 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.
current
object
Contains a config modifier and its related details.
- id
  string
  Contains the unique identifier of the config modifier.
  Format: uuid
- version
  number
  Indicates the iteration, or version number, of the config modifier. Version numbers start at 1 and increment every time a config modifier is updated.
- name
  string
  Displays the human-readable name of the config modifier.
- flavor
  string
  Indicates the type, or flavor, of config modifier. A put flavor alters data (creates or replaces) in a payload, while a delete flavor removes data from a payload.
  Possible Values: put, delete
- selector
  string
  Indicates the location(s) within the payload that this config modifier will operate on.
- schema
  object
  Required for a put flavor config modifier. Indicates how to build the value at the location the selector specifies.
- 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.
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®.