Skip to main content
POST
Copy points to devices
A copy is a point on another device that mirrors its source. Use copies to show the same point on a virtual device or on another equipment device without ingesting it twice. The request creates one copy for each pair of a point in pointIds and a device in deviceIds. The number of pairs, pointIds times deviceIds, cannot be more than 50. Repeated ids are merged. The request is refused with 400 before anything is written when:
  • A point or a device is not in this building.
  • A point is not an origin point. A copy cannot be copied.
  • The points sit on more than one device.
  • A device is the device or the base device of one of the points.
  • A device is not an origin or a virtual device.
The response has one item per pair, in the order of the request. Each item has a status:
  • CREATED: The copy was created.
  • COPY_EXISTS: The pair already has a copy. Nothing was created, so you can repeat a request safely.
  • LIMIT_REACHED: The source point already has the maximum of 200 copies.
Each CREATED item also carries the _id of the new copy, so you can read or delete it right away. The same _id appears in List point copies.
Copies are written device by device, not as one atomic change. If a later step fails, the response is 400, copies that were already written stay, and the rest are not attempted. List the copies, then send the request again. Pairs that already exist return COPY_EXISTS.
Deleting the source point deletes its copies. See Delete a point.

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.

Body

application/json
pointIds
string[]
required
Required array length: 1 - 50 elements
Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}
deviceIds
string[]
required
Required array length: 1 - 50 elements
Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}

Response

One item per point and device pair, in request order.

items
object[]