/layouts

get

https://{BaseUrl}/api/v3.0/layouts

This endpoint allows you to retrieve all the layouts associated with the account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available layouts, not the number of layouts resulting from the query string.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

include

array of strings

include

sort

array of strings

Defaults to +name

Comma separated list of of fields that should be sorted.

sort= - not providing any value will result in error 400
sort=+name,+name - same values will result in error 400
sort=-name,+name - mutially exclusive values will return error 400
maxItem=3 - Only Three values will be accepted, more will return error 400
qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
rotationOrder is ordering elements according to the user's list of Layout ids as configured in the user configuration parameter layoutSettings.rotationOrder. Layouts which are not in the list are ordered based on lower priority ordering params if specified, or by the default ordering if not specified.

sort

pageToken

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSize

integer

1 to 500

Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

name

string

Filter to get the layouts with the specified name. The lookup is exact and case insensitive.

name__in

array of strings

Filter to get the layouts whose name is on the provided list. The lookup is exact and case insensitive.

name__in

name__contains

string

Filter to get the layouts whose the name contains the provided substring. The lookup is exact and case insensitive.

id__in

array of strings

Filter to get the layouts whose id is on the provided list. The lookup is exact and case insensitive.

id__in

layoutPanes.cameras.bridgeId

string

Filter to get the layouts that contain cameras of given bridge id.

string

Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched: name, id, accountId.

qRelevance__gte

float

0 to 1

Defaults to 0.5

Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).

Responses

200Successfully fetched

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

500Something went wrong in the server. Please try again.