Create link

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

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.

Create link

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

This endpoint allows you to link one config modifier to one location.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/operations/configmodifiers/{configModifierId}/links' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "ownedBy": "source",
8
  "location": "source-request",
9
  "sourceId": "1ee1d994-652f-44b5-9342-4b3e8b9918ee",
10
  "destinationId": "39a858ea-4474-4d04-b37e-88862fe4054d",
11
  "dataModel": "PatientAdmin",
12
  "eventTypes": [
13
    "string"
14
  ]
15
}'

Path Parameters

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

Request Body Schema

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

location
required, string
Identifies where the link will be applied during log processing.
Possible Values: source-request, source-response, destination-request, destination-response
sourceId
required, string
Identifies the source that the link will apply to.
Format: uuid
destinationId
required, string
Identifies the destination that the link will apply to.
Format: uuid
dataModel
required, string
Identifies the Redox data model that the link will apply to.
eventTypes
required, Array of string
Indicates which event type(s) of the data model the config modifier will be 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.
ownedBy
string
Indicates whether the source or destination system will own the link. Only the owner can view the specific details or update a link.
Possible Values: source, destination

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": 122,
26
        "name": "string"
27
      },
28
      "connectingOrganization": {
29
        "id": 122,
30
        "name": "string"
31
      },
32
      "environment": {
33
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
34
      },
35
      "createdAt": "2024-04-25T18:17:16.719Z",
36
      "createdBy": {
37
        "id": 0,
38
        "name": "string"
39
      },
40
      "updatedAt": "2024-04-28T19:17:16.719Z",
41
      "updatedBy": {
42
        "id": 0,
43
        "name": "string"
44
      },
45
      "deletedAt": "2024-04-29T02:18:00.000Z",
46
      "deletedBy": {
47
        "id": 0,
48
        "name": "string"
49
      }
50
    }
51
  }
52
}

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
- configModifierLink
  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
  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.
  environment
  object
  Contains metadata about the environment within the associated Redox organization.
  id
  string
  Contains the unique identifier of the Redox environment.
  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.

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