2. List all channels

2. List all channels
Prev	Appendix C. Administrative API	Next

Request

The request URL for retrieving the list of all channels has the following form:

/channels/all/

The request must use the GET method.

Response

The response is a JSON object with the channels attribute as its only member. The channels attribute has an array as its value that contains an element for each channel. Each of these elements is an object with the following attributes:

Field name	Internal data type	JSON data type	Description
channelDataId	UUID	string	internal ID for the channel
channelName	string	string	channel’s name
controlSystemName	string	string	human-readable name of the control-system support used for the channel
controlSystemType	string	string	internal identifier for the control-system support used for the channel
decimationLevels	set of int	array of string	decimation levels that exist for the channel (specified in seconds)
serverId	UUID	string	ID of the server that owns the channel
serverName	string	string	human-readable name of the server that owns the channel

If the list of channels is currently not available, HTTP error code 503 (service unavailable) is returned and the response body is invalid.

Example

Request:

GET /admin/api/1.0/channels/all/

Response:

{
  "channels": [
    {
      "channelDataId": "ef126a63-375b-4f28-a1d1-17e8f42271a9",
      "channelName": "someChannel",
      "controlSystemName": "Channel Access",
      "controlSystemType": "channel_access",
      "decimationLevels": ["0", "30", "900"],
      "serverId": "7cf8f393-cd00-46ae-9343-53e9cb5793fd",
      "serverName": "myserver"
    },
    {
      "channelDataId": "0993955f-d16e-486d-ac3b-6a1841c0fd3f",
      "channelName": "someOtherChannel",
      "controlSystemName": "Channel Access",
      "controlSystemType": "channel_access",
      "decimationLevels": ["0"],
      "serverId": "7cf8f393-cd00-46ae-9343-53e9cb5793fd",
      "serverName": "myserver"
    }
  ]
}