Sign in
Logs

Get group suggestions

Returns a list of group suggestions based on the provided name fragment

get/api/logs/groups/suggest

Query parameters

namestring
scopeIdstring

Optional scope ID (e.g. connector ID) to restrict suggestions to that scope only.

Response

Array of matching group objects

groupIdstring required

The unique identifier of the group (e.g., south connector item group ID).

groupNamestring required

The human-readable name of the group.

scopeIdstring required

The unique identifier of the scope owning this group (e.g., connector ID).

scopeNamestring required

The human-readable name of the scope owning this group (e.g., connector or history query name).

Example response

[
  {
    "groupId": "group123",
    "groupName": "Temperature sensors",
    "scopeId": "connector123",
    "scopeName": "South Connector 1"
  }
]

Changes

Changed in 11 of the 73 revisions of this API.48