Home
API reference
Platform API
Platform API
Configs
Delete link

Delete link

delete/v1/operations/configLinks/{configLinkId}
Page View

Config endpoints allow you to review metadata of available Redox base configs and related source links. Learn about mapping operations.

Base configs can be linked to sources within your Redox organization to convert a payload from a one data format to the appropriate Redox data model or FHIR® resource.

Anyone in a Redox organization can view metadata of base configs and source links. However, only a Redoxer can view or modify the content of base configs, and only a user assigned to an engineer or support role can manage source links.

You can:

  • retrieve a list of available base configs;
  • retrieve a list of links attached to a source;
  • create base config links to sources;
  • update base config links to sources; or
  • delete base config links to sources.

Delete link

Delete an existing source link to a base config. This action can’t be undone.

You must be assigned to an engineer or support role to use this endpoint.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/configLinks/{configLinkId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • Contains the unique identifier of the base config link.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "string"
7
  }
8
}
  • 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
    • message
      string

      Explains that the delete request was successful, so the base config link no longer exists.