Skip to main content
GET
List point copies
Each copy is listed with its _id, its name, the device it sits on and its source point, each with its own _id. Filter by sourcePointId and deviceId to find the copy of one point on one device. An asc or dsc value that is not listed answers 400. A filter that matches nothing returns an empty page, not an error. The q parameter is ignored.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Query Parameters

asc
string

Sort ascending. The only accepted value is name.

deviceId
string

Only copies that sit on this device.

Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}
dsc
string
default:_id

Sort descending. Accepted values are name and _id. Default _id.

limit
integer<int32>
default:50

Number of items per page, from 1 to 200. Default 50.

Required range: 1 <= x <= 200
page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
q
string

Ignored.

sourcePointId
string

Only copies of this source point.

Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}

Response

A page of copies.

data
object[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>