Get environment config modifiers

get/v1/environments/{environmentId}/operations/configmodifiers

Page View

Closed beta feature

This is a closed beta feature for a limited pilot group. We're not currently accepting additional participants, but we'll let you know when it's available to everyone.

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.

Get environment config modifiers

Retrieve a list of existing config modifiers for a specific environment within a Redox organization. You can only retrieve a list of config modifiers for one environment per query.

The response contains a list of config modifiers with matching links based on the defined query parameters. However, if a config modifier is returned, the object contains all its associated links, not just the links that match the query parameters. If no links match the query parameters, the config modifier list is empty.

Request parameters

cURL request example

bash

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

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0",
4
    "links": {
5
      "self": "string",
6
      "next": "string",
7
      "prev": "string",
8
      "first": "string",
9
      "last": "string"
10
    },
11
    "totalRecords": 0,
12
    "currentPage": 0,
13
    "pageType": "offest",
14
    "pageSize": 0
15
  },
16
  "payload": {
17
    "configModifiers": [
18
      {
19
        "id": "3c45db50-6bb2-4cca-b1f9-76125ae9770f",
20
        "version": 0,
21
        "name": "string",
22
        "flavor": "put",
23
        "selector": "$.Patient.Identifiers[*].ID",
24
        "schema": {
25
          "plugin": {
26
            "name": "text",
27
            "action": "upper-case"
28
          }
29
        },
30
        "usage": [
31
          {
32
            "ownedBy": "source",
33
            "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
34
            "organization": {
35
              "id": 122,
36
              "name": "string"
37
            },
38
            "connectingOrganization": {
39
              "id": 122,
40
              "name": "string"
41
            },
42
            "processingLocation": "source-request",
43
            "subscription": {
44
              "dataModel": "PatientAdmin",
45
              "source": {
46
                "name": "string",
47
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
48
              },
49
              "destination": {
50
                "name": "string",
51
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
52
              }
53
            },
54
            "eventTypes": [
55
              "string"
56
            ]
57
          }
58
        ],
59
        "createdAt": "2024-04-25T18:17:16.719Z",
60
        "createdBy": {
61
          "id": 0,
62
          "name": "string"
63
        },
64
        "updatedAt": "2024-04-25T18:17:16.719Z",
65
        "updatedBy": {
66
          "id": 0,
67
          "name": "string"
68
        },
69
        "deletedAt": "2024-04-25T18:17:16.719Z",
70
        "deletedBy": {
71
          "id": 0,
72
          "name": "string"
73
        },
74
        "environment": {
75
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
76
        },
77
        "organization": {
78
          "id": 122,
79
          "name": "string"
80
        }
81
      }
82
    ]
83
  }
84
}

meta
object
Contains metadata about paginated results of returned data.
- 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.
- links
  object
  self
  string
  Links to the current page of results.
  next
  string
  Links to the next page of results.
  prev
  string
  Links to the previous page of results, which returns the page based on the current page you're on.
  first
  string
  Links to the first page of results.
  last
  string
  Links to the last page of results.
- totalRecords
  number
  Specifies the total number of records across all pages for the result set.
- currentPage
  number
  Specifies the current page number.
- pageType
  string
  Describes the pagination algorithm.
  Value: offest
- pageSize
  number
  Describes the number of records included in each page of the current result set.
payload
object
Contains the payload with details about the requested config modifier(s).
- configModifiers
  Array of object
  Contains an array of config modifiers.
  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.
  usage
  Array of object
  ownedBy
  string
  Indicates whether the source or destination system owns the link. Only the owner can view the specific details or update a link.
  Possible Values: source, destination
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  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.
  connectingOrganization
  object
  Specifies the organization the asset is connected to when the subscription relates to a partner organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  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
  subscription
  object
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  source
  object
  Specifies the source of the subscription that an asset is or should be linked to.
  id
  required, string
  Contains the unique identifier of the source.
  Format: uuid
  name
  nullable, string
  Specifies the name of the source.
  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
  name
  nullable, string
  Specifies the name of the destination.
  eventTypes
  Array of string
  Specifies the event types of the given Redox data model that the link applies to. If null, the config modifier is linked to all event types of the data model.
  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.

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