Create a new entity type

1min
POST
https://{tenantSubdomain}.io/core/api/v2/entity/entity-type
API for creating a new Entity Type
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-APPID
string
*
X-COREOS-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
EntityTypeCreateSchema
*
Description
Create new entity type
name
object
*
alias
object
category
Category[]
attributes
AttributeConfig[]
coreAttributes
CoreAttributeConfig[]
callback
CallbackMeta
isStateMachineEnabled
boolean
ttlOnInactive
boolean
events
string[]
entityCode
string
terminalTTL
TimeToLive
enableOrchestrator
boolean
Responses
202
OK
EntityTypeSuccessResponse
All Of
object  +
data
object
*
request
Request
*
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/entity-type' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": {
    "plural": "",
    "singular": ""
  },
  "alias": {
    "plural": "",
    "singular": ""
  },
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "attributes": [
    {
      "name": "",
      "dataType": "",
      "validation": {
        "range": {
          "min": 0,
          "max": 0
        },
        "required": false
      }
    }
  ],
  "coreAttributes": [
    {
      "name": "",
      "alias": ""
    }
  ],
  "callback": {
    "url": ""
  }
}'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/entity-type' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": {
    "plural": "",
    "singular": ""
  },
  "alias": {
    "plural": "",
    "singular": ""
  },
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "attributes": [
    {
      "name": "",
      "dataType": "",
      "validation": {
        "range": {
          "min": 0,
          "max": 0
        },
        "required": false
      }
    }
  ],
  "coreAttributes": [
    {
      "name": "",
      "alias": ""
    }
  ],
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
// OK 
{
  "data": {
    "name": "example - vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "name": "example - vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 16 Oct 2024
Did this page help you?
Get all entity types and their configurations