Get Custom Entity Type Tenants Query

Retrieves list of item for whom the custom entity type is explicitly published

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/customEntityTypes/{customEntityTypeId}/tenants

COPY

Path Parameters

string

customEntityTypeId

Required

customEntityTypeId

Query Parameters

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.

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.

ApiKeyAuth

Responses

200

Returns EntityReferences of type(s) application/json;version=39.1

This response body class contains all of the following: InlineEntityReferences0 , InlineEntityReferences1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "name": "string",
            "id": "string"
        }
    ]
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/customEntityTypes/{customEntityTypeId}/tenants?page=value&pageSize=v

Availability

Added in 37.2

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Custom Entities Operations

GET