Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API to manage and retrieve data related to "Web Containers Variables," specifically focusing on internal variables within web containers. The "Get Web Internal Variables" operation allows users to fetch details about specific internal variables by their ID or list them with optional query parameters for filtering, sorting, and pagination.

Typical use cases include:

  • Retrieving configuration or metadata of internal variables used in web container setups.
  • Automating monitoring or auditing of internal variable settings.
  • Integrating internal variable data into workflows for further processing or reporting.

For example, a user might want to get detailed information about a particular internal variable by its ID or list all internal variables filtered by certain criteria such as date ranges or types.

Properties

Name Meaning
Internal Variable ID The unique identifier of the internal variable to retrieve or delete. Required for operations that target a specific internal variable.
Query Parameters A collection of optional parameters to refine the request. These include:
- end: End date/time filter.
- Fields[template]: Template fields selection.
- filter: JSON object for complex filters.
- Various filter subfields like begin_date, end_date, from, rangeType, search, segment_id, sup_filters (device, location), to, types.
- granularity: Data granularity.
- include: Additional included data.
- page: Pagination info as JSON.
- sort: Sorting options (JSON or string depending on context).
- source: Source identifier.
- start: Start date/time filter.
- token: An optional token, treated as sensitive input.

Output

The output is a JSON array where each element corresponds to the response from the Commanders Act API for the requested internal variable(s). The structure depends on the API's response but generally includes detailed information about the internal variables such as their properties, metadata, and possibly status or usage data.

If the API returns no content, the node outputs an object indicating "Status Code": "204 No Content".

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2.
  • Proper API credentials must be configured in n8n to authenticate requests.
  • The node expects JSON-formatted request bodies for POST, PATCH, and PUT operations when applicable.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: For operations requiring an Internal Variable ID, if it is not provided, the node throws an error specifying the missing parameter.
  • API Errors: Any errors returned by the Commanders Act API are wrapped and rethrown as node errors with descriptive messages.
  • Invalid JSON in Request Body: If the request body JSON is malformed, the node will fail parsing it before sending the request.
  • Empty or Unexpected Response: If the API returns empty or non-JSON responses, the node attempts to parse or returns the raw text; unexpected formats may cause issues.

To resolve these issues:

  • Ensure all required parameters are provided.
  • Verify API credentials and permissions.
  • Validate JSON inputs.
  • Check network connectivity and API availability.

Links and References

This summary focuses on the "Web Containers Variable" resource and the "Get Web Internal Variables" operation as requested.

Discussion