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

string
customEntityTypeId
Required

customEntityTypeId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CustomEntityType of type(s) application/json;version=37.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
Optional

vroId

string
vroDynamicType
Optional

This refers to VRO's dynamic type.

string
name
Optional

Display name.

string
nss
Optional

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


404

Not Found

Operation doesn't return any data structure

Availability
Deprecated in 34.0
With alternative: see
definedEntities
On This Page
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
POST
Post Custom Entity Type Publish
POST
Post Custom Entity Type Publish All
POST
Post Custom Entity Type Unpublish
POST
Post Custom Entity Type Unpublish All
GET
Query Custom Entity Types
PUT
Set Custom Entity Type Tenants
PUT
Update Custom Entity Type