Logs

Get item suggestions

Changed on

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

get/api/logs/items/suggest

Request

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

Query parameters

namestring
scopeIdstring

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

Response

Array of matching item objects

itemIdstring required

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

itemNamestring required

The human-readable name of the item.

scopeIdstring required

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

scopeNamestring required

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

Example response

[
  {
    "itemId": "item123",
    "itemName": "Temperature sensor",
    "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