OnOffice icon

OnOffice

Consume OnOffice API

Actions30

IDs From Relation → Create

AI-generated

Overview

This node integrates with the OnOffice API to perform various operations on different resources related to real estate management. Specifically, for the "IDs From Relation" resource with the "Create" operation, it allows users to create new records associated with IDs derived from relations in the OnOffice system.

Common scenarios where this node is beneficial include automating data entry workflows, synchronizing external systems with OnOffice data, or programmatically managing real estate-related entities such as estates, addresses, agents logs, relations, tasks, and IDs from relations.

For example, a user might use this node to automatically create a new ID record linked to a relation after receiving input from another system, streamlining data consistency without manual intervention.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output (true/false).

Output

The node outputs JSON data structured as follows:

  • If Include Debug Info is enabled:

    • debug: Boolean flag indicating debug mode.
    • rawResponse: The full raw response object returned by the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

  • Otherwise:

    • success: Boolean indicating if the operation was successful.
    • resourceType: The resource involved (e.g., "idsfromrelation").
    • operation: The operation performed (e.g., "create").
    • data: An array containing the result data from the API (empty array if no data).

The output is wrapped in n8n's standard execution metadata format.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API.
  • Uses the OnOffice API endpoints:
    • Stable API: https://api.onoffice.de/api/stable/api.php (used only for "relation" resource with "getMany" operation).
    • Latest API: https://api.onoffice.de/api/latest/api.php (used for all other cases).
  • Relies on helper functions to generate HMAC signatures for secure API requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect resource or operation parameters may lead to API errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "OnOffice API error: <message>" indicates an error response from the API. The message provides details such as invalid parameters or authorization issues.
    • Unknown errors are reported as "Unknown error" if the API response lacks specific error details.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in the node credentials.
    • Ensure the resource and operation parameters match supported values.
    • Enable "Include Debug Info" to get detailed request and response data for troubleshooting.
    • Check network connectivity and firewall settings.

Links and References

Discussion