Home
API reference
Platform API reference
Platform API
Destinations
Run dataset tester

Run dataset tester

post/v1/destinations/{destinationId}/sendSampleDataset
Page View

Destination endpoints allow you to review and manage destinations in a specified environment.

You must be a member of the environment and be assigned to an engineer role to manage destinations. Learn about roles.

Run dataset tester

Send a sample dataset to one of your configured destinations. We currently only support sending HL7v2 ADT datasets to one of your configured destinations.

This verifies that your destination can receive expected data from sources in your subscription(s). In other words, this simulates the entire source-to-destination flow.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/destinations/{destinationId}/sendSampleDataset' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "datasetId": "hl7v2-adt"
8
}'

Path Parameters

  • destinationId
    required, string

    Contains the unique identifier of the endpoint where a dataset should be sent.

Request Body Schema

    Contains the fields that are required when using dataset tester.

  • datasetId
    string

    Defines the type of dataset to send with dataset tester.

    Value: hl7v2-adt

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
7
    "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
8
    "dataModels": [
9
      "FHIR.Event.PatientAdmin"
10
    ]
11
  }
12
}
  • 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 the payload with details about the requested destination.

    • sourceId
      string

      Contains the unique identifier of the test source that initiated the dataset test.

      Format: uuid
    • destinationId
      string

      Displays the unique identifier of the endpoint that will receive messages from Redox.

      Format: uuid
    • dataModels
      Array of string

      Includes a list of supported data models when using dataset tester.