Query Custom Entity Types

Get list of custom entity types.

Request

URI

GET

https://{api_host}/cloudapi/customEntityTypes

COPY

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

integer

page

Required

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns CustomEntityTypes of type(s) application/json;version=38.1

This response body class contains all of the following: Page , InlineCustomEntityTypes1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "vroId": "string",
            "vroDynamicType": "string",
            "name": "string",
            "nss": "string",
            "description": "string",
            "tenantScoped": false,
            "providerScoped": false,
            "publishAll": false
        }
    ]
}

Availability

Deprecated in 34.0

With alternative: see

definedEntities

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Custom Entities Operations