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 bundled source). Specifically, for the Resource "Object" and Operation "Updates Object Maintenance Data," it updates maintenance-related information of an object within a company system. This operation is useful in scenarios where you need to programmatically update details such as who connected or installed an object, assign an engineer responsible for the object, and optionally set timestamps for creation and last modification.

Practical examples include:

  • Automating updates to equipment maintenance records after service visits.
  • Synchronizing object maintenance data from external systems into your central database.
  • Tracking responsibility and installation details for assets managed across multiple locations.

Properties

Name Meaning
Company Id Identifier of the company owning the object.
Object Id Unique identifier of the object whose maintenance data is being updated.
Connected By Name or identifier of the person or entity who connected the object.
Installed By Name or identifier of the person or entity who installed the object.
Object Engineer Name or identifier of the engineer responsible for the object.
Additional Fields Optional fields that can be added:
- Created Date: Timestamp in milliseconds since Unix epoch.
- Last Modified Date: Timestamp in milliseconds since Unix epoch.

Output

The node outputs JSON data representing the result of the update operation on the object's maintenance data. The structure typically includes confirmation of the update and may echo back the updated fields or status messages from the Ajax API.

If binary data output is supported by other operations, it is not relevant here; this operation focuses on JSON structured maintenance data updates.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the Ajax API service endpoint to perform updates.
  • Uses internal HTTP client utilities to communicate with the backend.
  • Requires proper configuration of the API credentials within n8n to authorize requests.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing incorrect or non-existent Company Id or Object Id will result in errors or no updates applied.
    • Timestamps must be valid numbers representing milliseconds since the epoch; otherwise, the API might reject them.

  • Error Messages:

    • Authentication errors indicating invalid or missing API keys: Ensure the API key credential is correctly configured.
    • Validation errors about required fields: Verify all mandatory properties (Company Id, Object Id, Connected By, Installed By, Object Engineer) are provided.
    • API response errors related to resource not found: Confirm that the specified object exists in the given company context.

Links and References

Discussion