Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It provides various operations grouped by resources, including the "Hub" resource. The particular operation "Search Among The Hubs Attached To Company" allows users to query hubs associated with a given company, filtering and paginating results based on multiple optional criteria.

Common scenarios for this node include:

  • Retrieving a list of hubs linked to a company for monitoring or management purposes.
  • Filtering hubs by their binding states, channel states, installation status, or company lock status.
  • Paginating through large sets of hubs using limit and offset parameters.

Practical example:
A user wants to get all active hubs attached to a company with ID "12345", limiting the result to 100 entries starting from the first record. They can specify the company ID, set the installation state to "ACTIVE," and set the limit to 100.

Properties

Name Meaning
Company Id The unique identifier of the company whose hubs are being searched. This is required.
Hub Id Optional filter to specify a particular hub ID to search for among the company's hubs.
Hub Company Binding States Filter hubs by their binding state with the company. Options: PENDING_APPROVAL, APPROVED, PENDING_REMOVAL.
A911 Channel States Filter hubs by the state of their A911 channel. Options: INACTIVE, ACTIVE, PENDING_REMOVAL.
Translator Channel States Filter hubs by the state of their translator channel. Options: INACTIVE, ACTIVE, SLEEP.
Installation States Filter hubs by their installation state. Options: INACTIVE, ACTIVE.
Is Company Locked Boolean flag to filter hubs based on whether the company is locked (true) or not (false).
Limit Number specifying the maximum number of hubs to return. Default is 500.
Offset Number specifying the starting point in the list of hubs (for pagination). Default is 0.

Output

The node outputs JSON data representing the hubs matching the search criteria. The structure typically includes an array of hub objects, each containing details such as hub identifiers, states, and related channel statuses. The exact fields depend on the API response but generally provide comprehensive information about each hub attached to the specified company.

If binary data were involved, it would be summarized here; however, this node appears to output only JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service endpoint to perform the search operation.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional environment variables or n8n configurations beyond providing valid API credentials are indicated.

Troubleshooting

  • Invalid or missing Company Id: Since Company Id is required, omitting it will likely cause errors or empty results. Ensure it is provided and correctly formatted.
  • API authentication errors: If the API key credential is invalid or expired, the node will fail to authenticate. Verify the API key and update if necessary.
  • Filtering issues: Providing invalid values for filter options (e.g., unsupported states) may cause the API to reject the request or return no results. Use only the listed option values.
  • Pagination limits: Setting very high limits might lead to performance issues or timeouts depending on the API's capabilities.
  • Network or API downtime: Connectivity problems or API service outages will prevent successful execution.

Links and References

Note: The summary is based solely on static analysis of the provided source code and property definitions without runtime inspection or dynamic behavior inference.

Discussion