EAeagleeyenetworks
Layouts

GET /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.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/layouts
  • Auth
    HTTP bearer

Query parameters

includestring[]
sortstring[]

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.
pageTokenstring

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.

pageSizeinteger

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.

namestring

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

name__instring[]

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

name__containsstring

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

id__instring[]

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

layoutPanes.cameras.bridgeIdstring

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

qstring
Example:entrance

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__gtenumber float
Example: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).

Response

Successfully fetched

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "panes": [
        {
          "id": 1,
          "name": "front door",
          "type": "preview",
          "size": 1,
          "cameraId": "1003b545"
        }
      ],
      "settings": {
        "showCameraBorder": true,
        "showCameraName": true,
        "cameraAspectRatio": "16x9"
      },
      "name": "Main office floor 1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.