OnOffice icon

OnOffice

Consume OnOffice API

Actions30

IDs From Relation → Get

AI-generated

Overview

This node integrates with the OnOffice API to perform various operations on different resource types, including "IDs From Relation". Specifically, for the "IDs From Relation" resource with the "Get" operation, it retrieves a single record by its ID from the OnOffice system.

Common scenarios where this node is useful include:

  • Fetching detailed information about a specific relation's associated IDs in a real estate context.
  • Automating workflows that require retrieving and processing data linked to relations stored in OnOffice.
  • Integrating OnOffice data into other systems or dashboards by pulling specific records on demand.

For example, a user might want to retrieve all IDs related to a particular client (relation) to synchronize them with another CRM or to trigger follow-up actions based on the retrieved data.

Properties

Name Meaning
ID The unique identifier of the record to retrieve. Required for "get", "update", and "delete" operations.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API response and request details.

Output

The node outputs JSON data structured as follows:

  • On success:

    • success: true
    • resourceType: The resource queried (e.g., "idsfromrelation")
    • operation: The operation performed ("get")
    • data: An array containing the retrieved record(s) from OnOffice.

  • If "Include Debug Info" is enabled, the output includes:

    • debug: true
    • rawResponse: The full raw response from the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

  • On failure (if "Continue On Fail" is enabled):

    • success: false
    • error: Error message describing what went wrong.
    • resourceType and operation fields are also included.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API, which includes an API token and secret.
  • Uses the OnOffice API endpoints:
    • Stable API: https://api.onoffice.de/api/stable/api.php (used only when resource is "relation" and operation is "getMany")
    • Latest API: https://api.onoffice.de/api/latest/api.php (default for other cases)
  • The node internally generates HMAC signatures for secure API requests using the provided credentials.
  • Requires n8n HTTP Request helper for making POST requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent ID will result in an API error indicating the record was not found.
    • Network connectivity problems can prevent successful API calls.
    • Using the wrong resource-operation combination may lead to unexpected errors.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error; check the message for specifics.
    • "Unknown error" suggests the API response did not contain expected status information.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in n8n credentials.
    • Ensure the ID parameter is correct and corresponds to an existing record.
    • Enable "Include Debug Info" to get detailed request and response data for troubleshooting.
    • Use "Continue On Fail" option to handle errors gracefully within workflows.

Links and References

Discussion