Query Custom Entity Types

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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CustomEntityTypes of type(s) application/json;version=39.1
This response body class contains all of the following: InlineCustomEntityTypes0 , 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
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/customEntityTypes?page=value&pageSize=v
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