Skip to main content
POST
CreateChannelSchema

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to ChannelSchemaService_CreateChannelSchema.

The request for a call to ChannelSchemaService_CreateChannelSchema.

channel
string
required

The name of the channel (case-insensitive).

dataType
enum<string>
default:CHANNEL_DATA_TYPE_UNSPECIFIED
required
Available options:
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
assetName
string
required

The name of the asset (case-insensitive).

component
string

The name of the component (case-insensitive).

unit
string
enumTypes
object[]
bitFieldElements
object[]
organizationId
string

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

Response

A successful response.

The response of a call to ChannelSchemaService_CreateChannelSchema.