Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Object" resource with the operation "Get Object Responsible Person By Id." The node fetches data related to a responsible person associated with a specific object within a company.

Common scenarios for this node include:

  • Retrieving detailed information about the person responsible for a particular object in a company's system.
  • Integrating Ajax API data into workflows that require personnel assignment or responsibility tracking.
  • Automating reporting or notifications based on object-person relationships.

Example use case: A security management workflow where you need to get contact details of the person responsible for a security device (object) by providing the company ID, object ID, and person ID.

Properties

Name Meaning
Company Id The unique identifier of the company to which the object belongs.
Object Id The unique identifier of the object whose responsible person information is being fetched.
Person Id The unique identifier of the person responsible for the specified object.

Output

The node outputs JSON data containing the details of the responsible person for the given object. The exact structure depends on the Ajax API response but typically includes fields such as the person's name, contact information, role, and any other relevant metadata.

If the node supports binary data output, it would represent attachments or files related to the responsible person, but this is not explicitly indicated in the provided code.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential (referred generically as "an API key credential").
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional external dependencies beyond the Ajax API and its authentication.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid IDs: Providing incorrect companyId, objectId, or personId will likely result in errors or empty responses. Verify these IDs before execution.
  • Network issues: Connectivity problems with the Ajax API endpoint can cause request failures.
  • API rate limits: Excessive requests may be throttled; handle such errors gracefully.
  • Error messages: Typically relate to authorization failures, resource not found, or malformed requests. Check the input parameters and credentials.

Links and References

Discussion