Sift | Docs
APIReferenceREST (HTTP/JSON)Channel service

EXPERIMENTAL: This RPC is experimental and only available to a limited set of users.

GET
/api/v3/channels:filter

Query Parameters

pageSizeinteger

Format: "int64"

pageTokenstring

searchTermstring

The search term to match against channel names, components and descriptions. Optional.

isSearchCaseSensitiveboolean

If true, the search term is case sensitive. Optional, default false.

isSearchRegexpboolean

If true, the search term is treated as a regular expression. Optional, default false.

assetIdsarray<string>

If provided, only channels matching these asset_ids are returned. Optional

runIdsarray<string>

Only channels for these runs are returned. Optional

channelIdsarray<string>

If provided, only channels matching these channel_ids are returned. Optional

assetTagIdsarray<string>

If provided, only channels with assets with these tag_ids are returned. Optional

dataTypesarray<string>

If provide, only channels with these data types are returned. Optional.

metadataKeysarray<string>

If provided, only channels with this metadata are returned. Optional.

metadataValuesarray<string>

curl -X GET "<API_URL>/api/v3/channels:filter?pageSize=0&pageToken=string&searchTerm=string&isSearchCaseSensitive=true&isSearchRegexp=true&assetIds=string&runIds=string&channelIds=string&assetTagIds=string&dataTypes=CHANNEL_DATA_TYPE_UNSPECIFIED&metadataKeys=string&metadataValues=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "channels": [
    {
      "channelId": "string",
      "name": "string",
      "organizationId": "string",
      "assetId": "string",
      "assetName": "string",
      "description": "string",
      "displayDescription": "string",
      "unitId": "string",
      "displayUnitId": "string",
      "unit": "string",
      "displayUnit": "string",
      "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
      "enumTypes": [
        {
          "name": "string",
          "key": 0,
          "isSigned": true
        }
      ],
      "bitFieldElements": [
        {
          "name": "string",
          "index": 0,
          "bitCount": 0
        }
      ],
      "metadata": [
        {
          "key": {
            "name": "string",
            "type": "METADATA_KEY_TYPE_UNSPECIFIED",
            "archivedDate": "2019-08-24T14:15:22Z"
          },
          "stringValue": "string",
          "numberValue": 0.1,
          "booleanValue": true,
          "archivedDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Previous

CreateChannelSchema POST

Next

GetChannel GET