Skip to main content
POST
/
api
/
v1
/
channel-schemas:batch-create
BatchCreateChannelSchemas
curl --request POST \
  --url https://api.siftstack.com/api/v1/channel-schemas:batch-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requests": [
    {
      "channel": "<string>",
      "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
      "assetName": "<string>",
      "component": "<string>",
      "unit": "<string>",
      "enumTypes": [
        {
          "name": "<string>",
          "key": 123,
          "isSigned": true
        }
      ],
      "bitFieldElements": [
        {
          "name": "<string>",
          "index": 123,
          "bitCount": 123
        }
      ],
      "organizationId": "<string>"
    }
  ],
  "assetName": "<string>",
  "organizationId": "<string>"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt

Use this file to discover all available pages before exploring further.

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_BatchCreateChannelSchemas.

The request for a call to ChannelSchemaService_BatchCreateChannelSchemas.

​
requests
Limit of 1000 channels schemas per batch · object[]
required
​
assetName
string

The 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.

​
organizationId
string

The 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.

Response

A successful response.

The response of a call to ChannelSchemaService_BatchCreateChannelSchemas.