List points in a point group
Returns the points that belong to one point group, each with its current field and enum-mapping status. Use it to review a group before you apply a plan, or to pick single points.
deviceIds you used to discover the group, and the groupKey from the discovery response. Repeat the deviceIds parameter once for each device. Because the ids go in the URL, a very long list can exceed the request-line limit. Discover and drill into the devices in smaller batches if you reach it.
Each point shows the field, displayName, canonicalType, prefix, and suffix it carries now, if it is templated. enumStatus shows whether its enum values are mapped. Use a point’s id in the pointIds of a mapping to template that point apart from its group.
A groupKey that is malformed, or that matches no group of the selected devices, returns 400. Virtual points are never listed.Authorizations
Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.
Path Parameters
Building identifier from List buildings.
The group's server-derived key (from the point-groups query response).
64[^\p{C}\p{Z}]{1,128}Query Parameters
Sort ascending by a point field, such as name.
Device ids to scope the group to. Send the same devices you used to discover the group. Repeat the parameter for each id. At least 1 and at most 2,000 ids.
1 - 2000 elements255[^\p{C}\p{Z}]{1,128}Sort descending by a point field, such as name.
Comma-separated fields to return for each point. One or more of id, name, deviceId, deviceName, kind, writable, unitSymbol, pointEnum, field, displayName, canonicalType, prefix, suffix, and enumStatus. The default is every field. An unknown name returns 400.
Maximum number of points to return, from 1 to 200. The default is 50.
1 <= x <= 200Page number to return. The first page is 1.
x >= 1Return only points whose name contains this text.

