Skip to main content

​
Services

RPC methods exposed by this API.

​
ChannelService

MethodRequestResponseDescription
GetChannelGetChannelRequestGetChannelResponseRetrieve a channel
ListChannelsListChannelsRequestListChannelsResponseRetrieve channels using an optional filter.
UpdateChannelUpdateChannelRequestUpdateChannelResponseUpdate a channel
BatchArchiveChannelsBatchArchiveChannelsRequestBatchArchiveChannelsResponseBatch archives channels by setting active to false.
BatchUnarchiveChannelsBatchUnarchiveChannelsRequestBatchUnarchiveChannelsResponseBatch unarchives channels by setting active to true.

​
Messages

Data models used across requests/responses.

​
BatchArchiveChannelsRequest

The request for a call to ChannelService_BatchArchiveChannels.
FieldTypeLabelDescription
channel_idsstringrepeated

​
BatchArchiveChannelsResponse

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

​
BatchUnarchiveChannelsRequest

The request for a call to ChannelService_BatchUnarchiveChannels.
FieldTypeLabelDescription
channel_idsstringrepeated

​
BatchUnarchiveChannelsResponse

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

​
Channel

FieldTypeLabelDescription
channel_idstring
namestringThe full name of the channel.
asset_idstring
descriptionstring
unit_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
created_by_user_idstring
modified_by_user_idstring
data_typesift.common.type.v1.ChannelDataType
enum_typessift.common.type.v1.ChannelEnumTyperepeated
bit_field_elementssift.common.type.v1.ChannelBitFieldElementrepeated
display_descriptionstring
display_unit_idstring
metadatasift.metadata.v1.MetadataValuerepeated
activebool

​
FilterChannel

FieldTypeLabelDescription
channel_idstring
namestring
organization_idstring
asset_idstring
asset_namestring
descriptionstring
display_descriptionstring
unit_idstring
display_unit_idstring
unitstring
display_unitstring
data_typesift.common.type.v1.ChannelDataType
enum_typessift.common.type.v1.ChannelEnumTyperepeated
bit_field_elementssift.common.type.v1.ChannelBitFieldElementrepeated
metadatasift.metadata.v1.MetadataValuerepeated

​
FilterChannelsRequest

The request for a call to ChannelService_FilterChannels.
FieldTypeLabelDescription
page_sizeuint32
page_tokenstring
search_termstringThe search term to match against channel names, components and descriptions. Optional.
is_search_case_sensitiveboolIf true, the search term is case sensitive. Optional, default false.
is_search_regexpboolIf true, the search term is treated as a regular expression. Optional, default false.
asset_idsstringrepeatedIf provided, only channels matching these asset_ids are returned. Optional
run_idsstringrepeatedOnly channels for these runs are returned. Optional
channel_idsstringrepeatedIf provided, only channels matching these channel_ids are returned. Optional
asset_tag_idsstringrepeatedIf provided, only channels with assets with these tag_ids are returned. Optional
data_typessift.common.type.v1.ChannelDataTyperepeatedIf provide, only channels with these data types are returned. Optional.
metadata_keysstringrepeatedIf provided, only channels with this metadata are returned. Optional.
metadata_valuesstringrepeated

​
FilterChannelsResponse

The result of a call to ChannelService_FilterChannels.
FieldTypeLabelDescription
channelsFilterChannelrepeated
next_page_tokenstring

​
GetChannelRequest

The request for a call to ChannelService_GetChannel.
FieldTypeLabelDescription
channel_idstring

​
GetChannelResponse

The response of a call to ChannelService_GetChannel.
FieldTypeLabelDescription
channelChannel

​
ListChannelsRequest

The request for a call to ChannelService_ListChannels to retrieve channels.
FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA 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_bystringHow 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.
FieldTypeLabelDescription
channelsChannelrepeated
next_page_tokenstring

​
UpdateChannelRequest

The request for a call to ChannelService_UpdateChannel.
FieldTypeLabelDescription
channelChannel
update_maskgoogle.protobuf.FieldMaskThe 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.
FieldTypeLabelDescription
channelChannel

​
Enums

Allowed constant values used in message fields.