Get Custom Entities

Get Custom Entities

Get list of custom entities

Request
URI
GET
https://{api_host}/cloudapi/customEntities
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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CustomEntities of type(s) application/json;version=39.1 
{
    "entities": [
        {
            "id": "string",
            "name": "string",
            "customEntityTypeId": "string"
        }
    ]
}
array of object
entities
Optional

Definition of CustomEntity.


401

The user is not authorized

Operation doesn't return any data structure

403

The user does not have 'read' access rights for custom entity

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/customEntities
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