ChannelSchemaService

CreateChannelSchema v1

Create a channel schema

post/api/v1/channel-schemas

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/channel-schemas
  • Auth: HTTP bearer

Request body

componentstring

The name of the component (case-insensitive).

channelstring required

The name of the channel (case-insensitive).

unitstring
dataType'CHANNEL_DATA_TYPE_UNSPECIFIED' | 'CHANNEL_DATA_TYPE_DOUBLE' | 'CHANNEL_DATA_TYPE_STRING' | 'CHANNEL_DATA_TYPE_ENUM' | 'CHANNEL_DATA_TYPE_BIT_FIELD' | 'CHANNEL_DATA_TYPE_BOOL' | 'CHANNEL_DATA_TYPE_FLOAT' | 'CHANNEL_DATA_TYPE_INT_32' | 'CHANNEL_DATA_TYPE_UINT_32' | 'CHANNEL_DATA_TYPE_INT_64' | 'CHANNEL_DATA_TYPE_UINT_64' | 'CHANNEL_DATA_TYPE_BYTES' required
assetNamestring required

The name of the asset (case-insensitive).

organizationIdstring

This field is optional if the caller belongs to a single organization.

Response

A successful response.

ChannelSchemasv1CreateChannelSchemaResponse required

The response of a call to ChannelSchemaService_CreateChannelSchema.

Changes

No recorded changes to this operation across all 1 revision of this API.