Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically focusing on managing Data Cleansing Transformations when the "Data Cleansing" resource and "List Cleansing Transformations" operation are selected. It allows users to list cleansing transformations configured in their Commanders Act environment.

Typical use cases include:

  • Retrieving a list of data cleansing rules or transformations applied to datasets.
  • Automating workflows that require fetching cleansing transformation metadata for reporting or further processing.
  • Integrating cleansing transformation data into broader data management or analytics pipelines.

For example, a user might want to fetch all cleansing transformations to audit or synchronize them with another system.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request. These include:
- End (string): End date/time filter.
- Fields[template] (string): Template fields filter.
- Filter (JSON): Complex filter object.
- Filter[begin_date], Filter[end_date], Filter[from], Filter[to] (string): Date range filters.
- Filter[rangeType], Filter[search], Filter[segment_id], Filter[types] (string): Various filters.
- Filter[sup_filters][device][], Filter[sup_filters][location][] (string arrays): Sub-filters.
- Granularity (string): Data granularity level.
- Include (string): Additional included data.
- Page (JSON): Pagination details.
- Sort (JSON or string): Sorting options.
- Source (string): Source identifier.
- Start (string): Start date/time filter.
- Token (string, password type): Authentication token if needed for specific queries.

These properties allow fine-tuning the listing query to retrieve exactly the cleansing transformations relevant to the user's needs.

Output

The node outputs an array of JSON objects representing the cleansing transformations retrieved from the Commanders Act API. Each item corresponds to a cleansing transformation entity with its associated metadata as returned by the API.

If the API returns no content, the output will indicate a "204 No Content" status.

No binary data is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2 for API requests.
  • Proper configuration of the API credentials within n8n is necessary before using this node.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Commanders Act API key is correctly set up in n8n credentials.
  • Required Parameter Missing: For some operations, certain IDs or parameters are mandatory. For example, cleansing transformation ID is required for get, update, or delete operations. Ensure these are provided.
  • API Request Errors: Network issues or invalid parameters may cause API errors. Check the error message for details and verify the parameters and connectivity.
  • Parsing Errors: If the response cannot be parsed as JSON, the raw text is returned. This might indicate unexpected API responses; check API documentation or contact support.

Links and References


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

Discussion