ADVBOX icon

ADVBOX

Consume ADVBOX API

Actions8

Overview

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

Common scenarios where this node is beneficial include:

  • Automating retrieval of lawsuits matching specific criteria for reporting or monitoring.
  • Integrating lawsuit data into other workflows or systems for case management.
  • Paginating through large sets of lawsuit data to process or analyze them in batches.

For example, you could use this node to get all lawsuits related to a particular customer or filter lawsuits currently at a specific judicial stage.

Properties

Name Meaning
Name Lawsuit name or part of it (partial search supported).
Process Number Process number identifier of the lawsuit.
Protocol Number Protocol number associated with the lawsuit.
Customer ID Numeric ID of the customer linked to the lawsuit.
Group Filter lawsuits by group name or ID.
Type Filter lawsuits by type name or ID.
Responsible Filter lawsuits by responsible person’s name or ID.
Stage Filter lawsuits by stage name or ID (e.g., Judicial, Recursal).
Step Filter lawsuits by step name or ID (e.g., Aguardando retorno, Petição inicial).
Limit Number of items to return in the response; must be between 1 and 100.
Offset Number of items to skip before starting the response (used for pagination).

Output

The output is a JSON array containing lawsuit objects returned from the ADVBOX API. Each object represents a lawsuit record with its associated fields as provided by the API.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the ADVBOX API.
  • The node expects the ADVBOX API URL and token to be configured in the credentials.
  • Network access to the ADVBOX API endpoint is necessary.

Troubleshooting

  • Authentication errors: If the API token is missing or invalid, requests will fail. Ensure that the API key credential is correctly set up.
  • Invalid parameter values: Providing out-of-range values for limit or incorrect types for filters may cause API errors. Validate inputs before execution.
  • Pagination issues: Using an offset larger than the total number of available lawsuits will result in empty responses.
  • API request failures: Network issues or API downtime can cause request errors. Check connectivity and API status.
  • Error messages: Errors thrown by the node typically include the message from the API or network layer. Review these messages to identify issues like unauthorized access or malformed requests.

Links and References

Discussion