Workflow 7: DeviceHub Browse (Bulk Tag Discovery)

You are at https://api.litmus.io/workflows/browse-bulk-tags.md Parent: https://api.litmus.io/workflows/agents.md If this is the wrong workflow, back out to the index above.

7. DeviceHub Browse (Bulk Tag Discovery)

UI trigger: DeviceHub -> Browse -> Select tags -> Create All

The Browse workflow auto-discovers a device's full address space (e.g. all OPC UA nodes or Modbus registers) and lets users select which ones to import as tags - without manually entering each one.

Step table

Step API Name Method Endpoint / GraphQL Operation Input Output / What to capture
1 Create Browse Task POST {{edgeUrl}}/devicehub/v2 -> CreateBrowseTask Device ID + browse params Browse Task ID
2 Start Browse Task POST {{edgeUrl}}/devicehub/v2 -> StartBrowseTasks Browse Task ID from step 1 Task starts crawling
3 List Browse Tasks (poll) POST {{edgeUrl}}/devicehub/v2 -> ListBrowseTasks - Poll until Status = Completed
4 Get Browse Task Folders POST {{edgeUrl}}/devicehub/v2 -> BrowseTask_GetFoldersForTreeView Browse Task ID Folder tree of discovered address space
5 Get Browse Folder Items POST {{edgeUrl}}/devicehub/v2 -> BrowseTask_GetFolderItems Folder path within the browse task Items (tags/nodes) in that folder
opt Download Browse Tags (optional) GET {{edgeUrl}}/devicehub/browsing/download_csv/task/{{dh_browse_task_id}} Browse Task ID CSV of every discovered item, compatible with DeviceHub > Tags > Upload CSV
6 Cart Add Items POST {{edgeUrl}}/devicehub/v2 -> Cart_AddItems Selected item IDs from step 5 Items added to cart (Added, Skipped, Updated counts)
6b Cart Update Properties (optional) POST {{edgeUrl}}/devicehub/v2 -> Cart_UpdateProperties Property values to set (e.g. pollingInterval); applies to every item in the cart, not a subset Updated counts
7 Cart Create All Registers POST {{edgeUrl}}/devicehub/v2 -> Cart_CreateAllRegisters No input - processes entire cart Created, Skipped, Updated counts - tags now exist
8 Stop Browse Task (cleanup) POST {{edgeUrl}}/devicehub/v2 -> StopBrowseTasks Browse Task ID Crawling stops; discovered folders and items are kept
8 Delete Browse Task (cleanup) POST {{edgeUrl}}/devicehub/v2 -> DeleteBrowseTask Browse Task ID Task, folder tree and item index removed; cart items already added are not removed

Requires: a device whose driver supports browsing an address space (e.g. OPC UA Client Advanced). Other drivers fail Step 1 with browse is not supported.

CSV route: instead of the cart (steps 6-7), Download Browse Tags exports the discovered items to CSV for offline review; upload the edited file with DeviceHub > Tags > Upload CSV.


View this page as Markdown