AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation "Get Report Settings" under the "Reports" resource is designed to retrieve configuration or settings for a specific report type. It is useful in scenarios where users need to dynamically fetch report parameters or metadata before generating or displaying reports. For example, an analyst might use this node to get the settings of a sales report to understand filters or display options available.

Properties

Name Meaning
X USER ID The user identifier required for authentication or scoping the request.
Reporttype The type of report for which the settings are requested (e.g., "sales", "inventory").
Is Global Boolean flag indicating whether to fetch global report settings (true) or user-specific (false).

Output

The output JSON contains the report settings data retrieved from the API. This typically includes configuration details such as available filters, display options, default values, and other metadata related to the specified report type. The exact structure depends on the external API response but generally provides all necessary information to configure or generate the report accordingly.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authentication with the external AvantGuard ConnectSecure service.
  • Needs the base URL of the API configured in the node credentials.
  • Depends on the external API endpoint defined in the bundled OpenAPI specification (openapi.json), which handles the "Get Report Settings" request.

Troubleshooting

  • Missing or invalid X USER ID: The node requires a valid user ID header; ensure it is provided and correctly formatted.
  • Invalid reporttype value: If the report type does not exist or is misspelled, the API may return an error or empty settings.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or connectivity issues: Ensure the base URL is reachable and the network allows outbound requests to the API.
  • Boolean parameter handling: Confirm that the "Is Global" property is correctly passed as a boolean; some APIs are sensitive to string vs boolean types.

Links and References


Note: The summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion