Create config modifier

post/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.

Create config modifier

Create a config modifier for a specific environment within a Redox organization. You can specify the details for a config modifier via API or the Redox dashboard (learn how to create a config modifier in the dashboard).

This endpoint allows you to create config modifier at a time.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/operations/configmodifiers' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
"name": "string",
8
"flavor": "put",
9
"selector": "$.Patient.Identifiers[*].ID",
10
"schema": {
11
"plugin": {
12
"name": "text",
13
"action": "upper-case"
14
}
15
}
16
}'

Path Parameters

  • environmentId
    required, string

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

Request Body Schema

    Contains the fields that you can populate to create a new or update an existing config modifier.

  • name
    required, string

    Contains the human-readable name of the config modifier.

  • flavor
    required, 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 something.

    Possible Values: put, delete
  • selector
    required, 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.

    Response fields and example

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

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