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=38.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

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