API DocsRESTChannel schema service

BatchCreateChannelSchemas

Create a batch of channel schemas

POST
/api/v1/channel-schemas:batch-create

Request Body

application/jsonRequired

The request for a call to ChannelSchemaService_BatchCreateChannelSchemas.

requests
Required
Limit of 1000 channels schemas per batch

assetNamestring

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.

organizationIdstring

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.

curl -X POST "<API_URL>/api/v1/channel-schemas:batch-create" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "requests": [
      {
        "component": "string",
        "channel": "string",
        "unit": "string",
        "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
        "enumTypes": [
          {
            "name": "string",
            "key": 0
          }
        ],
        "bitFieldElements": [
          {
            "name": "string",
            "index": 0,
            "bitCount": 0
          }
        ],
        "assetName": "string",
        "organizationId": "string"
      }
    ],
    "assetName": "string",
    "organizationId": "string"
  }'

A successful response.

{}

Previous

ValidateExpression POST

Next

CreateChannelSchema POST