Skip to main content

Channels

Channels define in which output channels or environments an entity should be available. This mechanism is particularly important in combination with the Venus Module, which uses channel assignments both for filtering and for controlling visibility.

info

Our available channels are not publicly listed.
If you need to know which channels are available, and you should use, please contact us or your project lead.

Structure​

Each entity can be linked to multiple channels. A channel is referenced by its unique identifier.

{
  "channels": [
    "605c5f2f4f1a25679cb3c123",
    "605c5f2f4f1a25679cb3c456"
  ]
}

Using channels​

Channels can be assigned directly when creating a new entity or can be added, updated, removed later via the described Endpoint below.

Request​

PATCH 
/:id/channels
{
  "channels": [
    {
      "_id": "605c5f2f4f1a25679cb3c123"
    },
    {
      "_id": "605c5f2f4f1a25679cb3c456",
      "remove": true
    }
  ]
}

Response​

  • If the entity does not exist, the Gateway returns a 404 Not Found.
  • If one or more channel do not exist, the Gateway returns a 404 Not Found.
    "The following channel(s) do not exist [<channel>]"