Unimus icon

Unimus

Consume Unimus API (v.0.9.7)

Actions6

Devices → Get devices

AI-generated

Overview

This node interacts with the Unimus API to retrieve device information. Specifically, the 'Get devices' operation fetches a list of devices from the Unimus system, supporting both API versions v2 and v3. It allows users to specify various filtering and pagination parameters to tailor the device data retrieved. This node is useful for network administrators or IT professionals who want to automate the retrieval and processing of device inventories from Unimus for monitoring, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve all devices with default pagination and no filters.
  2. Fetch devices filtered by specific addresses, vendors, or types using API version v3.
  3. Get a paginated list of devices with custom page size and index using API version v2.

Properties

Name Meaning
Ignore SSL Issues Whether to ignore SSL certificate validation errors and still download the response.
API Version Selects the Unimus API version to use (v2 or v3).
Additional Parameters (v2) Optional parameters for API v2 such as page index, page size, and device attributes to include.
Additional Parameters (v3) Optional parameters for API v3 including filters like addresses, descriptions, vendors, types, models, zone UUIDs, schedule UUIDs, time range (since/until), and pagination (page/size).
Simplify Output Whether to simplify the output data structure for easier consumption.

Output

JSON

  • ``
    • deviceId - Unique identifier of the device.
    • address - Network address of the device.
    • vendor - Vendor or manufacturer of the device.
    • type - Type or category of the device.
    • model - Model name or number of the device.
    • zoneUuid - UUID of the zone the device belongs to.
    • scheduleUuid - UUID of the schedule associated with the device.
    • description - Description or notes about the device.

Dependencies

  • Unimus API

Troubleshooting

  • Ensure the correct API version (v2 or v3) is selected to match the Unimus server configuration.
  • Verify that the API credentials are valid and have sufficient permissions to access device data.
  • If SSL issues occur, consider enabling 'Ignore SSL Issues' to bypass certificate validation, but be aware of security risks.
  • Check that pagination parameters (page and size) are set correctly to avoid empty or incomplete results.
  • When using API v3 filters, ensure that multi-value fields are correctly formatted as arrays of strings.
  • Common error: 'The operation is not supported for resource and version' indicates a mismatch between selected resource, operation, and API version. Adjust parameters accordingly.

Links

Discussion