OnOffice

Consume OnOffice API

Actions12

Relation → Delete

AI-generated

Overview

This node integrates with the OnOffice API to manage "Relation" resources, specifically allowing users to delete a relation by its ID. Relations represent links between estates and addresses (contacts) in the OnOffice system.

A common use case for the Delete operation is when you want to remove an existing association between an estate and a contact, such as removing a tenant or owner relation from a property record.

Practical example:

  • You have a property listed with several contacts linked as owners or tenants. When a tenant moves out, you can use this node's Delete operation on the Relation resource to remove that tenant's relation from the property.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete. This is required for the Delete operation.

Output

The node outputs a JSON object indicating the success of the deletion operation. The structure includes:

  • success: Boolean indicating if the operation was successful (true).
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A status message returned from the OnOffice API confirming the deletion.

Example output JSON:

{
  "success": true,
  "resourceType": "relation",
  "operation": "delete",
  "message": "Relation deleted successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the OnOffice API, including an API token and secret.
  • The node makes authenticated HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/v1.
  • Proper configuration of the API credentials within n8n is necessary for authentication and HMAC signature generation.

Troubleshooting

  • Common issues:

    • Invalid or missing Relation ID: The node requires a valid relation ID to delete; ensure this is provided.
    • Authentication errors: If API credentials are incorrect or expired, the request will fail.
    • Network errors: Connectivity issues may prevent reaching the OnOffice API.

  • Error messages:

    • OnOffice API error: <message>: Indicates the API responded with an error. Check the message for details, such as invalid ID or permission issues.
    • Network error: <message>: Indicates a failure to connect to the API endpoint. Verify network connectivity and API URL.
    • Filter must be a valid JSON: Not applicable for Delete but relevant for other operations if filters are used incorrectly.

  • Resolution tips:

    • Double-check the Relation ID input.
    • Verify API credentials and permissions.
    • Ensure the OnOffice API service is reachable from your environment.

Links and References

Discussion