Get Custom Entity Type

Get Custom Entity Type

Get specified custom entity type

Request
URI
GET
https://{api_host}/cloudapi/customEntityTypes/{customEntityTypeId}
COPY
Path Parameters
string
customEntityTypeId
Required

customEntityTypeId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CustomEntityType of type(s) application/json;version=39.1 
{
    "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
Constraints: default:

description

boolean
tenantScoped
Optional
Constraints: default: true

tenantScoped

boolean
providerScoped
Optional
Constraints: default: true

providerScoped

boolean
publishAll
Optional

Read-only value indicating publishAll state


404

Not Found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/customEntityTypes/{customEntityTypeId}
Deprecated
Availability
Deprecated in 34.0
With alternative: see
definedEntities
On This Page
Custom Entities Operations
GET
Query Custom Entity Types
Deprecated
POST
Create Custom Entity Type
Deprecated
GET
Get Custom Entity Type
Deprecated
PUT
Update Custom Entity Type
Deprecated
DELETE
Delete Custom Entity Type
Deprecated
GET
Get Custom Entity Type Tenants
Deprecated
PUT
Set Custom Entity Type Tenants
Deprecated
POST
Post Custom Entity Type Publish
Deprecated
POST
Post Custom Entity Type Unpublish
Deprecated
POST
Post Custom Entity Type Publish All
Deprecated
POST
Post Custom Entity Type Unpublish All
Deprecated
GET
Get Custom Entity Type Tenants Query
PUT
Set Custom Entity Type Tenants Bounded
POST
Post Custom Entity Type Publish Bounded
POST
Post Custom Entity Type Unpublish Bounded
POST
Post Custom Entity Type Publish All Bounded
POST
Post Custom Entity Type Unpublish All Bounded
GET
Get Custom Entity Type Actions
POST
Create Custom Entity Type Action
DELETE
Delete Custom Entity Type Action
GET
Get Custom Entities
GET
Get Custom Entity
GET
Get Custom Entity As Sdk Object