channels

Services

RPC methods exposed by this API.

ChannelService

Method	Request	Response	Description
GetChannel	GetChannelRequest	GetChannelResponse	Retrieve a channel
ListChannels	ListChannelsRequest	ListChannelsResponse	Retrieve channels using an optional filter.
UpdateChannel	UpdateChannelRequest	UpdateChannelResponse	Update a channel
BatchArchiveChannels	BatchArchiveChannelsRequest	BatchArchiveChannelsResponse	Batch archives channels by setting active to false.
BatchUnarchiveChannels	BatchUnarchiveChannelsRequest	BatchUnarchiveChannelsResponse	Batch unarchives channels by setting active to true.

Messages

Data models used across requests/responses.

BatchArchiveChannelsRequest

The request for a call to ChannelService_BatchArchiveChannels.

Field	Type	Label	Description
channel_ids	string	repeated

BatchArchiveChannelsResponse

The result of a call to ChannelService_BatchArchiveChannels. This message has no fields.

BatchUnarchiveChannelsRequest

The request for a call to ChannelService_BatchUnarchiveChannels.

Field	Type	Label	Description
channel_ids	string	repeated

BatchUnarchiveChannelsResponse

The result of a call to ChannelService_BatchUnarchiveChannels. This message has no fields.

Channel

Field	Type	Label	Description
channel_id	string
name	string		The full name of the channel.
asset_id	string
description	string
unit_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
data_type	sift.common.type.v1.ChannelDataType
enum_types	sift.common.type.v1.ChannelEnumType	repeated
bit_field_elements	sift.common.type.v1.ChannelBitFieldElement	repeated
display_description	string
display_unit_id	string
metadata	sift.metadata.v1.MetadataValue	repeated
active	bool

FilterChannel

Field	Type	Label
channel_id	string
name	string
organization_id	string
asset_id	string
asset_name	string
description	string
display_description	string
unit_id	string
display_unit_id	string
unit	string
display_unit	string
data_type	sift.common.type.v1.ChannelDataType
enum_types	sift.common.type.v1.ChannelEnumType	repeated
bit_field_elements	sift.common.type.v1.ChannelBitFieldElement	repeated
metadata	sift.metadata.v1.MetadataValue	repeated

FilterChannelsRequest

The request for a call to ChannelService_FilterChannels.

Field	Type	Label	Description
page_size	uint32
page_token	string
search_term	string		The search term to match against channel names, components and descriptions. Optional.
is_search_case_sensitive	bool		If true, the search term is case sensitive. Optional, default false.
is_search_regexp	bool		If true, the search term is treated as a regular expression. Optional, default false.
asset_ids	string	repeated	If provided, only channels matching these asset_ids are returned. Optional
run_ids	string	repeated	Only channels for these runs are returned. Optional
channel_ids	string	repeated	If provided, only channels matching these channel_ids are returned. Optional
asset_tag_ids	string	repeated	If provided, only channels with assets with these tag_ids are returned. Optional
data_types	sift.common.type.v1.ChannelDataType	repeated	If provide, only channels with these data types are returned. Optional.
metadata_keys	string	repeated	If provided, only channels with this metadata are returned. Optional.
metadata_values	string	repeated

FilterChannelsResponse

The result of a call to ChannelService_FilterChannels.

Field	Type	Label	Description
channels	FilterChannel	repeated
next_page_token	string

GetChannelRequest

The request for a call to ChannelService_GetChannel.

Field	Type	Label	Description
channel_id	string

GetChannelResponse

The response of a call to ChannelService_GetChannel.

Field	Type	Label	Description
channel	Channel

ListChannelsRequest

The request for a call to ChannelService_ListChannels to retrieve channels.

Field	Type	Description
page_size	uint32	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.
page_token	string	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.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `channel_id`, `asset_id`, `name`, `description` `run_id`, `run_name`, `run_client_key`, `created_date`, `modified_date`, `created_by_user_id`, and `modified_by_user_id`. 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.
order_by	string	How to order the retrieved channels. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `name`, `created_date` and `modified_date`, `active`. 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”

ListChannelsResponse

The result of a call to ChannelService_ListChannels.

Field	Type	Label	Description
channels	Channel	repeated
next_page_token	string

UpdateChannelRequest

The request for a call to ChannelService_UpdateChannel.

Field	Type	Label	Description
channel	Channel
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `display_description`, `display_units`, `metadata`, and `active`.

UpdateChannelResponse

The result of a call to ChannelService_UpdateChannel.

Field	Type	Label	Description
channel	Channel

Enums

Allowed constant values used in message fields.

Authenticate

Clients

Review

Export

Endpoints & protobuf definitions

Services

ChannelService

Messages

BatchArchiveChannelsRequest

BatchArchiveChannelsResponse

BatchUnarchiveChannelsRequest

BatchUnarchiveChannelsResponse

Channel

FilterChannel

FilterChannelsRequest

FilterChannelsResponse

GetChannelRequest

GetChannelResponse

ListChannelsRequest

ListChannelsResponse

UpdateChannelRequest

UpdateChannelResponse

Enums

​Services

​ChannelService

​Messages

​BatchArchiveChannelsRequest

​BatchArchiveChannelsResponse

​BatchUnarchiveChannelsRequest

​BatchUnarchiveChannelsResponse

​Channel

​FilterChannel

​FilterChannelsRequest

​FilterChannelsResponse

​GetChannelRequest

​GetChannelResponse

​ListChannelsRequest

​ListChannelsResponse

​UpdateChannelRequest

​UpdateChannelResponse

​Enums

Services

ChannelService

Messages

BatchArchiveChannelsRequest

BatchArchiveChannelsResponse

BatchUnarchiveChannelsRequest

BatchUnarchiveChannelsResponse

Channel

FilterChannel

FilterChannelsRequest

FilterChannelsResponse

GetChannelRequest

GetChannelResponse

ListChannelsRequest

ListChannelsResponse

UpdateChannelRequest

UpdateChannelResponse

Enums