Logs

Get group suggestions

Changed on

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

get/api/logs/groups/suggest

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/logs/groups/suggest
  • Auth: none required

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

  • fe8fd32c9fdcRevision changes
    • info

      added the new optional query request parameter scopeId

  • 20f6974b3c56Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status