Skip to main content

EntityTypeCreate

Payload used to create Entity Type. Required fields are name, collection_id.

nameName (string)required

lower_snake_case identifier from 1 to 63 characters. It must start with a lowercase letter or underscore and may contain lowercase letters, digits, and underscores.

Possible values: Value must match regular expression ^[a-z_][a-z0-9_]{0,62}$

alias object
anyOf
string
type object
anyOf
string
collection_idCollection Id (string)required

Parent collection ID (required)

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
  • string
  • ]
  • groupsstring[]

    Classification groups within the collection

    description object
    anyOf
    string
    schema object

    Entity attribute schema (JSON)

    anyOf
    object
    EntityTypeCreate
    {
    "name": "string",
    "alias": "string",
    "type": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "groups": [
    "string"
    ],
    "description": "string",
    "schema": {}
    }