Home
API reference
Platform API reference
Platform API
Config modifiers
Get link

Get link

get/v1/operations/configmodifierlinks/{configModifierLinkId}
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 link

Retrieve one related link for an existing config modifier based on its unique identifier. Links indicate where the config modifier is applied during log processing.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/configmodifierlinks/{configModifierLinkId}' \
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
  },
5
  "payload": {
6
    "configModifierLink": {
7
      "id": "dc5d2a43-df19-459c-b14f-450584ce1c55",
8
      "configModifierId": "f84d602d-7449-4a13-b9a4-8688cae85726",
9
      "configModifierVersion": 0,
10
      "ownedBy": "source",
11
      "processingLocation": "source-request",
12
      "dataModel": "PatientAdmin",
13
      "eventTypes": [
14
        "string"
15
      ],
16
      "source": {
17
        "id": "1ee1d994-652f-44b5-9342-4b3e8b9918ee",
18
        "name": "string"
19
      },
20
      "destination": {
21
        "id": "39a858ea-4474-4d04-b37e-88862fe4054d",
22
        "name": "string"
23
      },
24
      "organization": {
25
        "id": 0,
26
        "name": "string"
27
      },
28
      "environment": {
29
        "id": "e049f44d-99b2-4790-b4c6-19c0c21d1234"
30
      },
31
      "createdAt": "2024-04-25T18:17:16.719Z",
32
      "createdBy": {
33
        "id": 0,
34
        "name": "string"
35
      },
36
      "updatedAt": "2024-04-28T19:17:16.719Z",
37
      "updatedBy": {
38
        "id": 0,
39
        "name": "string"
40
      },
41
      "deletedAt": "2024-04-29T02:18:00.000Z",
42
      "deletedBy": {
43
        "id": 0,
44
        "name": "string"
45
      }
46
    }
47
  }
48
}
  • 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

    • Contains a config modifier link and its related details.

      • id
        string

        Displays the unique identifier of the link for a given config modifier.

        Format: uuid
      • configModifierId
        string

        Contains the unique identifier of the config modifier that the link applies to a given subscription.

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

        Format: uuid
      • 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
      • processingLocation
        string

        Identifies where the link is applied during log processing.

        Possible Values: source-request, source-response, destination-request, destination-response
      • dataModel
        string

        Identifies the Redox data model that the link applies to.

      • eventTypes
        Array of string

        Indicates which event type(s) of the data model the config modifier is linked to. If not restricted to certain event types, you must explicitly set this field to null; this means the config modifier is linked to all event types.

      • source
        object

        Specifies the source of the subscription that the config modifier is linked to.

        • id
          string

          Contains the unique identifier of the source.

        • name
          nullable, string

          Displays the human-readable name of the source.

      • destination
        object

        Specifies the destination of the subscription that the config modifier is linked to.

        • id
          string

          Contains the unique identifier of the destination.

        • name
          nullable, string

          Displays the human-readable name of the destination.

      • 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
      • createdAt
        string

        Displays the date and time that the link 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 link 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 link was deleted. Returns a null value if the link 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 user's full name.