Update entity type configuration

1min
PUT
https://{tenantSubdomain}.io/core/api/v2/entity/entity-type/{entityTypePluralName}
API to update the basic configuration of a entity type specified by EntityTypePluralName.
Path Parameters
entityTypePluralName
EntityTypePluralName
*
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
EntityTypeUpdateRequest
*
Description
Update entity type configuration
category
Category[]
coreAttributes
CoreAttributeConfig[]
attributes
AttributeConfig[]
events
string[]
alias
object
enableOrchestrator
boolean
ttlOnInactive
boolean
callback
CallbackMeta
terminalTTL
TimeToLive
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
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/entity-type/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "coreAttributes": [
    {
      "name": "",
      "alias": ""
    }
  ],
  "attributes": [
    {
      "name": "",
      "dataType": "",
      "validation": {
        "range": {
          "min": 0,
          "max": 0
        },
        "required": false
      }
    }
  ],
  "alias": {
    "plural": "",
    "singular": ""
  },
  "callback": {
    "url": ""
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/entity-type/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "coreAttributes": [
    {
      "name": "",
      "alias": ""
    }
  ],
  "attributes": [
    {
      "name": "",
      "dataType": "",
      "validation": {
        "range": {
          "min": 0,
          "max": 0
        },
        "required": false
      }
    }
  ],
  "alias": {
    "plural": "",
    "singular": ""
  },
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
404
// 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 configuration of a entity type