onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node interacts with the onOffice API to retrieve task data. Specifically, the "Task - Get All" operation fetches multiple tasks from the onOffice system based on optional filters and sorting options. It is useful for scenarios where you want to list or process many tasks at once, such as generating reports, syncing tasks with other systems, or monitoring task assignments.

For example, you could use this node to:

  • Retrieve all tasks assigned to a specific user.
  • Filter tasks related to a particular address or estate.
  • Sort tasks by their title or modification date to prioritize processing.

Properties

Name Meaning
Limit Max number of task results to return (minimum 1).
Filters Collection of optional filters to narrow down tasks:
- Title: Filter tasks by their title (Betreff).
- Assigned User ID: Filter tasks by the ID of the user responsible (Verantwortung).
- Related Address ID: Filter tasks linked to a specific address.
- Related Estate ID: Filter tasks linked to a specific estate.
Options Additional options for result customization:
- Sort by: Field to sort results by; options are Title, Created At, Modified At.
- Sort Direction: Direction to sort results; Ascending or Descending.

Output

The output is an array of JSON objects representing tasks matching the query. Each task object includes fields such as:

  • id: Unique identifier of the task.
  • Betreff: The task's title.
  • Aufgabe: Description or details of the task.
  • relatedAddressId: ID of the related address, if any.
  • relatedEstateId: ID of the related estate, if any.
  • Verantwortung: Assigned user ID responsible for the task.
  • Angelegt am: Creation timestamp.
  • Geaendert am: Last modified timestamp.

If no tasks match the criteria, the node outputs a success message indicating no results were found.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • Makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • Uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API authentication token and secret are not configured.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, an error is thrown.
  • API errors: If the onOffice API returns an error status code, the node surfaces the API error message.
  • Parsing issues: If the response format changes or is unexpected, the node may fail to parse results and return a message indicating no results or parsing failure.
  • Limit value: Setting the limit below 1 may cause validation errors; ensure it is at least 1.

To resolve these issues:

  • Verify that valid API credentials are set up in n8n.
  • Double-check resource and operation selections.
  • Confirm filter values are correct and correspond to existing data.
  • Review API limits and permissions associated with your API key.

Links and References

Discussion