Get environment config modifiers

get/v1/environments/:environmentId/operations/configmodifiers
Page View

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.

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
"organization": {
23
"id": 0,
24
"name": "string"
25
},
26
"environment": {
27
"id": "e049f44d-99b2-4790-b4c6-19c0c21d1234"
28
},
29
"flavor": "put",
30
"selector": "$.Patient.Identifiers[*].ID",
31
"schema": {
32
"plugin": {
33
"name": "text",
34
"action": "upper-case"
35
}
36
},
37
"createdAt": "2024-04-25T18:17:16.719Z",
38
"createdBy": {
39
"id": 0,
40
"name": "string"
41
},
42
"updatedAt": "2024-04-28T19:17:16.719Z",
43
"updatedBy": {
44
"id": 0,
45
"name": "string"
46
},
47
"deletedAt": "2024-04-29T02:18:00.000Z",
48
"deletedBy": {
49
"id": 0,
50
"name": "string"
51
}
52
}
53
]
54
}
55
}
  • 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.

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

      • organization
        object

        Contains metadata about the Redox organization.

        • id
          number

          Identifies the specific Redox organization that you're operating in or on behalf of.

        • name
          nullable, string

          Displays the human-readable name of the Redox organization that you're operating in or on behalf of.

      • environment
        object

        Contains metadata about the environment within the associated Redox organization.

        • id
          string

          Identifies the specific environment that you're operating in or on behalf of.

          Format: uuid
      • 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 config modifier 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 config modifier was last updated.

        • 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 config modifier was deleted. Returns a null value if the config modifier hasn't been deleted.

        • deletedBy
          nullable, object

          Contains metadata about the user who performed the delete. Returns a null value if the config modifier hasn't been deleted.

          • id
            number

            Contains the unique identifier of the user.

          • name
            nullable, string

            Displays the full name of the user.