Create Custom Entity Type
Creates a new custom entity type
Request
URI
POST
https://{api_host}/cloudapi/customEntityTypes
COPY
Request Body
CustomEntityType of type(s) application/json
Optional
{
"id": "string",
"vroId": "string",
"vroDynamicType": "string",
"name": "string",
"nss": "string",
"description": "string",
"tenantScoped": false,
"providerScoped": false,
"publishAll": false
}
string
id
Optional
UUID for custom entity type. This is immutable.
string
vroId
Required
vroId
string
vroDynamicType
Required
This refers to VRO's dynamic type.
string
name
Required
Display name.
string
nss
Required
This refers to a unique namespace specific string.
string
description
Optional
description
boolean
tenantScoped
Optional
tenantScoped
boolean
providerScoped
Optional
providerScoped
boolean
publishAll
Optional
Read-only value indicating publishAll state
Responses
201
Created
Returns CustomEntityType of type(s) application/json;version=38.0
{
"id": "string",
"vroId": "string",
"vroDynamicType": "string",
"name": "string",
"nss": "string",
"description": "string",
"tenantScoped": false,
"providerScoped": false,
"publishAll": false
}
string
id
Optional
UUID for custom entity type. This is immutable.
string
vroId
Required
vroId
string
vroDynamicType
Required
This refers to VRO's dynamic type.
string
name
Required
Display name.
string
nss
Required
This refers to a unique namespace specific string.
string
description
Optional
description
boolean
tenantScoped
Optional
tenantScoped
boolean
providerScoped
Optional
providerScoped
boolean
publishAll
Optional
Read-only value indicating publishAll state
Availability
Deprecated in 34.0
With alternative: see
definedEntities
Custom Entities Operations
POST
Create Custom Entity Type
POST
Create Custom Entity Type Action
DELETE
Delete Custom Entity Type
DELETE
Delete Custom Entity Type Action
GET
Get Custom Entities
GET
Get Custom Entity
GET
Get Custom Entity As Sdk Object
GET
Get Custom Entity Type
GET
Get Custom Entity Type Actions
GET
Get Custom Entity Type Tenants
GET
Get Custom Entity Type Tenants Query
POST
Post Custom Entity Type Publish
POST
Post Custom Entity Type Publish All
POST
Post Custom Entity Type Publish All Bounded
POST
Post Custom Entity Type Publish Bounded
POST
Post Custom Entity Type Unpublish
POST
Post Custom Entity Type Unpublish All
POST
Post Custom Entity Type Unpublish All Bounded
POST
Post Custom Entity Type Unpublish Bounded
GET
Query Custom Entity Types
PUT
Set Custom Entity Type Tenants
PUT
Set Custom Entity Type Tenants Bounded
PUT
Update Custom Entity Type