Create link (beta)

post/v1/operations/filters/{filterId}/links

Page View

Filter endpoints allow you to review and manage filters for async messages. A filter can contain multiple rules, but you can only create one filter per subscription. Learn about filters.

You can retrieve, create, update, or delete filters.

Beta users may also use the endpoints for reviewing and managing filter links.

Create link (beta)

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.

Create a link for an existing filter to the specified subscription. The link immediately applies the filter to traffic in the specified environment.

You can only create one link per filter.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/operations/filters/{filterId}/links' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "source": {
8
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
9
  },
10
  "destination": {
11
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
12
  },
13
  "dataModel": "PatientAdmin"
14
}'

Path Parameters

filterId
required, string
Displays the unique identifier of the filter.

Request Body Schema

source
required, 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
destination
required, 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
dataModel
required, string
Specifies the Redox data model that the link applies to or should apply to.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "filterLink": {
7
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
      "organization": {
9
        "id": 122,
10
        "name": "string"
11
      },
12
      "connectingOrganization": {
13
        "id": 122,
14
        "name": "string"
15
      },
16
      "subscription": {
17
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
18
        "dataModel": "PatientAdmin",
19
        "source": {
20
          "name": "string",
21
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
22
        },
23
        "destination": {
24
          "name": "string",
25
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
26
        }
27
      },
28
      "filterId": "aff0ee0f-f371-4b82-82c6-dc3b96f05c91",
29
      "version": "1.0.0",
30
      "eventType": "string",
31
      "createdAt": "2024-04-25T18:17:16.719Z",
32
      "createdBy": {
33
        "id": 0,
34
        "name": "string"
35
      },
36
      "updatedAt": "2024-04-25T18:17:16.719Z",
37
      "updatedBy": {
38
        "id": 0,
39
        "name": "string"
40
      },
41
      "deletedAt": "2024-04-25T18:17:16.719Z",
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
- filterLink
  object
  id
  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.
  subscription
  object
  id
  string
  Contains the unique identifier of the subscription.
  Format: uuid
  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.
  filterId
  string
  Contains the unique identifier of the asset being linked.
  Format: uuid
  version
  string
  Contains the API schema version used for this asset.
  eventType
  nullable, string
  Specifies the specific event type for a data model that the link applies to or should apply to.
  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.

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