channel_schemas

Protocol buffer definition for channel_schemas

sift/channel_schemas/v1/channel_schemas.proto

BatchCreateChannelSchemasRequest

The request for a call to ChannelSchemaService_BatchCreateChannelSchemas.

FieldTypeLabelDescription
requestsCreateChannelSchemaRequestrepeatedLimit of 1000 channels schemas per batch
asset_namestringThe asset to which the channel schemas belong (case-insensitive). If this field, and any of the child requests specify an asset, the assets must match.
organization_idstringThe organization to which the channel schemas belong. If this field, and any of the child requests specify an organization_id, the organization_ids must match. This field is optional if the caller belongs to a single organization.

BatchCreateChannelSchemasResponse

The response of a call to ChannelSchemaService_BatchCreateChannelSchemas.

CreateChannelSchemaRequest

The request for a call to ChannelSchemaService_CreateChannelSchema.

FieldTypeLabelDescription
componentstringThe name of the component (case-insensitive).
channelstringThe name of the channel (case-insensitive).
unitstring
data_typesift.common.type.v1.ChannelDataType
enum_typessift.common.type.v1.ChannelEnumTyperepeated
bit_field_elementssift.common.type.v1.ChannelBitFieldElementrepeated
asset_namestringThe name of the asset (case-insensitive).
organization_idstringThis field is optional if the caller belongs to a single organization.

CreateChannelSchemaResponse

The response of a call to ChannelSchemaService_CreateChannelSchema.

ChannelSchemaService

Method NameRequest TypeResponse TypeDescription
CreateChannelSchemaCreateChannelSchemaRequestCreateChannelSchemaResponseCreate a channel schema
BatchCreateChannelSchemasBatchCreateChannelSchemasRequestBatchCreateChannelSchemasResponseCreate a batch of channel schemas

On this page