OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, agents logs, relations, tasks, and IDs from relations. Specifically for the Relation resource with the Delete operation, it deletes a relation record identified by its ID.

Common scenarios include:

  • Removing outdated or incorrect relation records from your OnOffice database.
  • Automating cleanup of relations in bulk workflows.
  • Integrating deletion steps into larger automation processes involving real estate data management.

Example: Automatically delete a relation record when it is no longer relevant, triggered by an external event or condition in your workflow.

Properties

Name Meaning
ID The unique identifier of the relation record to delete. This is required for deletion.
Include Debug Info Boolean flag to include detailed debug information in the output, useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • On success (without debug info):

    {
  "success": true,
  "resourceType": "relation",
  "operation": "delete",
  "data": []
}

    This indicates the deletion was successful.

  • On success (with debug info enabled):

    {
  "debug": true,
  "rawResponse": { /* full API response object */ },
  "requestSent": { /* full request payload sent to API */ },
  "url": "https://api.onoffice.de/api/latest/api.php"
}

    This includes raw API response and request details for debugging purposes.

  • On failure (if continueOnFail is enabled):

    {
  "success": false,
  "error": "Error message describing what went wrong",
  "resourceType": "relation",
  "operation": "delete"
}

The node does not output binary data.

Dependencies

  • Requires an API token credential and secret for authenticating with the OnOffice API.
  • Uses the OnOffice API endpoint https://api.onoffice.de/api/latest/api.php for most operations including deleting relations.
  • The node internally generates HMAC signatures for secure API requests.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing ID parameter will cause the API to reject the request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can cause request failures.

  • Common error messages:

    • "OnOffice API error: <message>": Indicates an error returned by the OnOffice API. Check the message for specifics like invalid ID or permission issues.
    • If the node throws an error without continuing on fail, verify that the ID exists and credentials are valid.

  • How to resolve:

    • Ensure the ID corresponds to an existing relation record.
    • Verify API token and secret are correctly configured and active.
    • Enable "Include Debug Info" to get detailed request/response data for diagnosing issues.
    • Use n8n’s "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

  • OnOffice API Documentation (official API docs for further details)
  • n8n documentation on HTTP Request Node (for understanding underlying HTTP calls)
  • n8n community forums and support channels for troubleshooting custom nodes and API integrations.

Discussion