ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

The node integrates with the Advbox API to manage and retrieve task-related data. Specifically, the "Get Tasks" operation under the "Task" resource allows users to fetch a filtered list of tasks based on various criteria such as date ranges, user assignments, task types, and pagination controls.

This node is beneficial in scenarios where you need to automate workflows involving task management within the Advbox system, such as:

  • Retrieving tasks assigned to specific users or related to particular lawsuits.
  • Filtering tasks by creation, completion, deadline, or appointment dates.
  • Paginating through large sets of tasks for reporting or further processing.

For example, you could use this node to automatically pull all urgent tasks assigned to a user within a certain date range and then trigger notifications or updates in other systems.

Properties

Name Meaning
Additional Fields A collection of optional filters and parameters to refine the task retrieval query. It includes:
- Date Start Start date filter for the appointment date (format: yyyy-mm-dd).
- Date End End date filter for the appointment date (format: yyyy-mm-dd).
- Created Start Start date filter for the task creation date (format: yyyy-mm-dd). Must be used together with Created End.
- Created End End date filter for the task creation date (format: yyyy-mm-dd). Must be used together with Created Start.
- Deadline Start Start date filter for the task deadline (format: yyyy-mm-dd). Must be used together with Deadline End.
- Deadline End End date filter for the task deadline (format: yyyy-mm-dd). Must be used together with Deadline Start.
- Completed Start Start date filter for the task completion date (format: yyyy-mm-dd). Must be used together with Completed End.
- Completed End End date filter for the task completion date (format: yyyy-mm-dd). Must be used together with Completed Start.
- User Select a user to filter tasks by their assigned user ID. The options are dynamically loaded from the Advbox API.
- User Name Filter tasks by the name of the user.
- Task Type Select a task type to filter tasks. Options are dynamically loaded from the Advbox API.
- ID Filter by the ID of a specific assigned task.
- Lawsuit ID Filter tasks by the associated lawsuit ID.
- Limit Number of items to return in the response. Must be between 1 and 100. Defaults to 50.
- Offset Number of items to skip before starting the response (used for pagination). Minimum value is 0. Defaults to 0.

Output

The output is a JSON array containing task objects retrieved from the Advbox API's /posts endpoint. Each item represents a task matching the specified filters.

The structure of each task object depends on the Advbox API but typically includes fields such as task ID, user assignment, dates (creation, deadline, completion), task type, lawsuit association, and other metadata.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Advbox API.
  • The node expects the Advbox API base URL and token to be configured in the credentials.
  • Dynamic loading of options (e.g., users, task types) depends on successful API calls to the Advbox settings endpoint.
  • Proper date formatting (yyyy-mm-dd) is required for date filter fields.

Troubleshooting

  • Invalid or missing API token: The node will throw an error if the API token is not provided or invalid. Ensure that the API key credential is correctly set up.
  • Incorrect date formats: Date filters must be in yyyy-mm-dd format. Using incorrect formats may cause API errors or empty results.
  • Pagination issues: Setting limit too high or negative values for offset can cause errors. Use values within the allowed ranges.
  • API request failures: Network issues or incorrect API URLs will result in request errors. Verify connectivity and credential configuration.
  • Empty or unexpected responses: If no tasks match the filters, the node returns an empty array. Check filter criteria for correctness.

Links and References

Discussion