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.
Responses
200
OK
Returns CustomEntityTypes of type(s) application/json;version=36.2
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
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