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 description). Specifically, for the Resource "Object" and Operation "Update Object General Info," it allows users to update various general information fields of an object within the Ajax system. This can include updating company IDs, object IDs, contact details, addresses, schedules, agreements, and other metadata related to the object.

Common scenarios where this node would be beneficial include:

  • Automating updates to object records when company or object details change.
  • Synchronizing object information from external systems into the Ajax platform.
  • Managing schedules and contact information programmatically for objects.
  • Updating legal agreement details associated with an object.

Practical example: A security management system could use this node to update the address, phone numbers, and schedule of a monitored location automatically when changes occur in the corporate database.

Properties

Name Meaning
Company Id Identifier of the company owning the object. Required.
Object Id Identifier of the object to update. Required.
Additional Fields Optional collection of additional fields to update on the object, including:
- id Internal identifier (string).
- version Version number of the object (number).
- companyId Company Id override (string).
- hubId Hub identifier (string).
- generalInfo Collection of general information fields such as:
-- registrationNumber Registration number (string).
-- name Name of the object (string).
-- address Address details including country, state, city, zip code, address lines 1 and 2.
-- phoneNumber Multiple phone numbers (each with a "Number" string field).
-- emailAddresses Multiple email addresses (each with an "Email" string field).
-- location Latitude and longitude coordinates as strings with precision up to 6 decimal places.
-- falseAlarmPassword Password string used for false alarm handling.
-- detectOffScheduleDisarm Boolean flag indicating whether to detect disarming outside scheduled times.
-- schedule Weekly schedule specifying multiple time ranges per day (Monday through Sunday), each with "From" and "To" times in local ISO8601 'HH:mm:ss.SSS' format.
-- timezone Timezone string for the schedule.
-- agreement Agreement details including number, signing date, termination date (both as milliseconds since epoch), company legal name, and notes.
- sleepUntil Timestamp (milliseconds since epoch) until which the object should sleep.
- channelState State of the communication channel (string).
- scheduledRemoval Timestamp (milliseconds since epoch) when the object is scheduled for removal.
- createdDate Creation timestamp (milliseconds since epoch).
- lastModifiedDate Last modification timestamp (milliseconds since epoch).

Output

The node outputs JSON data representing the updated object information after the operation completes. The structure reflects the updated fields sent to the Ajax API, including any changes made to general info, schedules, agreements, and metadata.

If the node supports binary data output, it is not explicitly indicated here; thus, the primary output is structured JSON data describing the object's updated state.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on internal backend modules for HTTP client communication and operation execution.
  • The node uses a versioned Ajax API endpoint (version specified in the node description).
  • No explicit environment variables are mentioned, but proper API credentials must be configured in n8n.

Troubleshooting

  • Missing Required Fields: Errors may occur if "Company Id" or "Object Id" are not provided. Ensure these required fields are set.
  • Invalid Date Formats: Timestamps must be provided as milliseconds since the Unix epoch. Incorrect formats may cause failures.
  • Schedule Time Format: Schedule times must follow the 'HH:mm:ss.SSS' ISO8601 local time format. Invalid formats can lead to errors.
  • API Authentication Failures: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems with the Ajax API endpoint will prevent successful updates.
  • Version Conflicts: If the "version" field is used, ensure it matches the current object version to avoid update conflicts.

Links and References

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution or access to private/internal identifiers.

Discussion