AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node interacts with the AvantGuard CIPP API to retrieve BPA (Business Process Automation) templates associated with a specific list. It is designed to fetch detailed template data by specifying the list's unique identifier and optionally controlling the format of the returned JSON data.

Common scenarios for this node include:

  • Automating workflows that require fetching BPA templates linked to particular lists.
  • Integrating BPA template retrieval into larger automation pipelines where template details are needed dynamically.
  • Using the raw JSON response for custom processing or further API interactions.

For example, a user might want to retrieve all BPA templates for a given list ID to analyze or modify them within an automated process.

Properties

Name Meaning
Id The unique identifier of the list for which BPA templates are to be retrieved.
Rawjson A string parameter that likely controls whether the response should be returned as raw JSON or processed differently.

Output

The node outputs JSON data representing the BPA templates associated with the specified list ID. The structure of the json output field corresponds to the API response from the AvantGuard CIPP service, typically including details about each BPA template.

If the Rawjson property is used to request raw JSON, the output will contain the unprocessed JSON response from the API.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard CIPP API.
  • The base URL for the API is configured via credentials (resourceApiUrl).
  • Depends on the @avantguardllc/n8n-openapi-node package and an OpenAPI specification file (openapi.json) bundled with the node.

Troubleshooting

  • Invalid or missing List Id: Since the Id property is required, omitting it or providing an incorrect value will likely cause the API call to fail or return no data.
  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Malformed Rawjson parameter: If the Rawjson parameter expects specific values (e.g., "true" or "false"), providing invalid input may cause unexpected behavior.
  • Network issues: Connectivity problems to the API endpoint will result in request failures; verify network access and API availability.

Links and References

Discussion