Get Accessible Locations

Gets locations accessible to this session.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/sessions/{id:((?!provider|current).)+}/accessibleLocations

COPY

Query Parameters

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 AccessibleLocations of type(s) application/json;version=38.1

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

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "locationId": "string",
            "site": {
                "name": "string",
                "id": "string"
            },
            "org": {
                "name": "string",
                "id": "string"
            },
            "restApiEndpoint": "string",
            "uiEndpoint": "string",
            "apiVersion": "string"
        }
    ]
}

Availability

Added in 33.0

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Sessions Operations

GET

Get Accessible Locations