OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, relations, agent logs, and tasks. Specifically for the Task - Delete operation, it deletes a task record identified by its ID from the OnOffice system.

Common scenarios where this node is useful include:

  • Automating cleanup of completed or obsolete tasks in OnOffice.
  • Integrating task management workflows where tasks created elsewhere need to be removed from OnOffice automatically.
  • Synchronizing task deletions between OnOffice and other systems.

Example: Automatically delete a task in OnOffice when it is marked as done in another project management tool.

Properties

Name Meaning
ID The unique identifier of the task record to delete. This is required to specify which task to remove.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API response and request data. Useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • On success (when Include Debug Info is false):

    {
  "success": true,
  "resourceType": "task",
  "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 provides detailed insight into the API interaction.

  • On failure (if not continuing on fail):
    Throws an error with message starting with OnOffice API error: followed by the API's error message.

  • On failure (if continuing on fail is enabled):

    {
  "success": false,
  "error": "Error message here",
  "resourceType": "task",
  "operation": "delete"
}

The node does not output binary data.

Dependencies

  • Requires valid credentials for the OnOffice API, specifically an API token and secret.
  • Uses HMAC signature generation for authenticating requests.
  • Makes HTTP POST requests to the OnOffice API endpoint:
    https://api.onoffice.de/api/latest/api.php
  • Requires n8n environment configured with these credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing task ID 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.
    • API rate limits or server errors may cause unexpected failures.

  • Common error messages:

    • OnOffice API error: <message> — Indicates an error returned by the OnOffice API. Check the message for details.
    • If no specific message is provided, it defaults to "Unknown error".

  • How to resolve:

    • Verify the task ID is correct and exists in OnOffice.
    • Ensure API credentials are correctly set up and have necessary permissions.
    • Enable "Include Debug Info" to get detailed request/response data for diagnosis.
    • Check network connectivity and retry if transient errors occur.
    • Consult OnOffice API documentation or support if persistent API errors occur.

Links and References

Discussion