Create a new Entity

1min
POST
https://{tenantSubdomain}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}
API for creating a new Entity of entity type specified by entityTypePluralName.
Path Parameters
entityTypePluralName
EntityTypePluralName
*
appId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
EntityCreateRequestCategory
*
Description
Create new Entity
uniqueCode
string
*
name
string
owner
string
*
category
string
subCategory
string
properties
object
*
templateId
string
state
string
callback
CallbackForInstance
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
Responses
202
OK
SuccessResponse
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
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "uniqueCode": "",
  "owner": "",
  "properties": {},
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {}
  }
}'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "uniqueCode": "",
  "owner": "",
  "properties": {},
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "method": "",
    "onResponse": {}
  }
}'
Responses
202
400
401
404
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 25 Jun 2024
Did this page help you?
Update entity type configuration
Get list of Entities of a entity type.