ImmyBot icon

ImmyBot

ImmyBot Node

Overview

The node provides functionality to retrieve a paged list of computers from an external system via an API. It supports filtering, sorting, and pagination options to customize the query results. This is useful in scenarios where you need to manage or analyze large inventories of computers, such as IT asset management, monitoring onboarding status, or identifying stale or offline machines.

Practical examples include:

  • Fetching all computers currently onboarding for targeted configuration.
  • Retrieving only licensed computers for compliance reporting.
  • Getting a specific page of computers sorted by last active date to display in a dashboard.

Properties

Name Meaning
Filter Filter computers by criteria (e.g., name, status)
Skip Number of records to skip for pagination
Sort Field to sort the results by
Take Number of records to take (page size)
Sort Descending Whether to sort in descending order (true/false)
Onboarding Only Whether to show only computers that are onboarding
Stale Only Whether to show only stale computers
Dev Lab Only Whether to show only development lab computers
Include Offline Whether to include offline computers in results
Tenant ID Filter by specific tenant ID
Licensed Only Whether to show only licensed computers
Deleted Only Whether to show only deleted computers
Return Individual Items Whether to return each computer as a separate output item instead of grouped in an array

Output

The node outputs JSON data representing the list of computers retrieved according to the specified filters and pagination. If "Return Individual Items" is enabled, each computer is output as a separate item; otherwise, all computers are grouped into a single array within one output item.

If the node supports binary data output (not indicated here), it would typically represent files or attachments related to computers, but this node focuses on JSON data.

Dependencies

  • Requires an API key credential for authentication with the external ImmyBot service.
  • The base URL for API requests is dynamically constructed using a subdomain from credentials.
  • The node expects the external API to support filtering, sorting, and pagination parameters as per the input properties.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter or sort field names may result in API errors or empty results.
    • Pagination parameters out of range could lead to no data returned.
  • Error messages:
    • Authentication errors indicate problems with the provided API key or OAuth token.
    • Validation errors from the API may point to unsupported filter or sort values.
  • Resolutions:
    • Verify and update API credentials in n8n settings.
    • Check filter and sort fields against the API documentation.
    • Adjust pagination parameters to valid ranges.

Links and References

Discussion