OnOffice Relation

Manage relationships between estates and addresses

Actions4

Overview

This node manages relationships between estates and addresses in the OnOffice system. It allows users to find single or multiple relations, create new relations, and delete existing ones. Typical use cases include querying which addresses are related to a specific estate (e.g., owners, tenants), adding new relations between estates and addresses, or removing outdated relations.

For example:

  • Finding all tenant relations for a given estate.
  • Creating a new owner relation linking an address to an estate.
  • Deleting a specific relation by its ID.

Properties

Name Meaning
Fields to Return Select which fields to include in the output. Options: ID, Type, Estate ID, Address ID
Filter by Type Filter relations by type. Options: Any, Owner, Tenant, Interested, Contact
Filter by Estate ID Filter relations by a specific estate ID
Filter by Address ID Filter relations by a specific address ID
Limit Maximum number of results to return
Offset Number of results to skip before starting to collect the result set

These properties apply when performing the "Find Many" operation.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the operation succeeded.
  • operation: The performed operation name (find, findMany, create, or delete).
  • data: For "find" and "findMany", this contains an array of relation records with the requested fields. For "create", it contains the created relation data. For "delete", this is typically empty.
  • total: (Only for "findMany") Total count of matching records available.
  • message: Informational message from the API, especially for "create" and "delete".
  • error: Present only if the operation failed, containing the error message.

If binary data were involved, it would be summarized here, but this node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • The node internally generates HMAC signatures for request authentication.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing incorrect relation IDs for "find" or "delete" operations will result in errors.
    • Filters that do not match any records will return empty data arrays.
    • Exceeding API rate limits or network issues may cause request failures.

  • Error messages:

    • "OnOffice API action error: <message>": Indicates the API returned an error for the requested action. Check the message for details.
    • "OnOffice API error: <message>": General API error, possibly due to malformed requests or server issues.
    • Network or HTTP errors will propagate as standard n8n errors.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Double-check input parameters like relation IDs and filters.
    • Use smaller limits or offsets if large data sets cause timeouts.
    • Enable "Continue on Fail" to handle individual item errors gracefully.

Links and References

Discussion