ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

This node integrates with the Advbox API to retrieve multiple lawsuit records based on various filter criteria. It is designed to fetch a list of lawsuits, supporting pagination and filtering by attributes such as name, process number, protocol number, customer ID, group, type, responsible person, stage, and step.

Common scenarios where this node is beneficial include:

  • Automating retrieval of lawsuit data for reporting or monitoring.
  • Integrating lawsuit information into workflows that require batch processing or analysis.
  • Filtering lawsuits dynamically based on specific criteria like responsible user or lawsuit stage.

For example, a legal team could use this node to automatically pull all active lawsuits assigned to a particular responsible person and then trigger follow-up actions or notifications.

Properties

Name Meaning
Additional Fields A collection of optional filters and pagination settings to refine the lawsuit query:
- Name Lawsuit name or part of it (string).
- Process Number Process number of the lawsuit (string).
- Protocol Number Protocol number of the lawsuit (string).
- Customer ID Numeric ID of the customer associated with the lawsuit.
- Group Filter lawsuits by group (selectable options loaded dynamically from API).
- Type Filter lawsuits by type (selectable options loaded dynamically from API).
- Responsible Filter lawsuits by responsible person (selectable options loaded dynamically from API).
- Stage Filter lawsuits by stage (selectable options loaded dynamically from API).
- Step Filter lawsuits by step; options include Marketing, Negotiation, Consulting, Administrative, Judicial, Appeals, Execution/Collection, HR/Finance, Archiving.
- Limit Number of items to return in the response (number between 1 and 100).
- Offset Number of items to skip before starting the response (for pagination).

Output

The node outputs an array of lawsuit objects matching the specified filters. Each item in the output contains a json field with the lawsuit data returned by the Advbox API. The structure corresponds directly to the API's lawsuit resource representation, including fields such as name, process number, protocol number, customer association, group, type, responsible user, stage, step, and other relevant metadata.

No binary data output is produced 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 option loading for some properties depends on successful API calls to endpoints like /settings to fetch users, lawsuit groups, types, and stages.

Troubleshooting

  • Missing or invalid API token: The node will throw an error if the API token is not provided or invalid. Ensure the API key credential is correctly set up.
  • Invalid API URL: If the API base URL is missing or malformed, requests will fail. Verify the URL in the credential configuration.
  • Filter parameter errors: Providing invalid values for filters (e.g., non-numeric customer ID) may cause the API to reject the request.
  • Pagination issues: Setting limit outside the allowed range (1-100) may result in errors or unexpected results.
  • API connectivity problems: Network issues or API downtime can cause request failures. Check network connectivity and Advbox service status.
  • Error messages from API: Errors returned by the Advbox API are propagated. Review the error message for details and adjust parameters accordingly.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion