API DocsRESTChannel service

ListChannels

Retrieve channels using an optional filter.

GET
/api/v2/channels

Query Parameters

pageSizeinteger

The maximum number of channels to return. The service may return fewer than this value. If unspecified, at most 50 channels will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. Optional.

Format: "int64"

pageTokenstring

A page token, received from a previous ListChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChannels must match the call that provided the page token. Optional.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are channel_id, asset_id, name, component, description, active, created_date, and modified_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

organizationIdstring

This field is only required if your user belongs to multiple organizations.

orderBystring

How to order the retrieved channels. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

curl -X GET "<API_URL>/api/v2/channels?pageSize=0&pageToken=string&filter=string&organizationId=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "channels": [
    {
      "channelId": "string",
      "name": "string",
      "component": "string",
      "assetId": "string",
      "description": "string",
      "unitId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "organizationId": "string",
      "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
      "enumTypes": [
        {
          "name": "string",
          "key": 0
        }
      ],
      "bitFieldElements": [
        {
          "name": "string",
          "index": 0,
          "bitCount": 0
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Previous

GetChannel GET

Next

GetData POST