Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API to manage data cleansing transformations, specifically allowing users to destroy (delete) cleansing transformations. It is useful in scenarios where you need to programmatically remove outdated or incorrect data cleansing rules from your Commanders Act environment to maintain clean and accurate data processing pipelines.

For example, if a cleansing transformation is no longer relevant or was created by mistake, this node can be used to delete it automatically as part of an automated workflow.

Properties

Name Meaning
Cleansing Transformation ID The unique identifier of the cleansing transformation to be destroyed (deleted).
Query Parameters Optional additional parameters to customize the API request, such as filters, pagination, etc.

The "Query Parameters" collection supports various optional fields like:

  • end, start: Date/time boundaries for filtering.
  • filter and its subfields: JSON or string filters for refined queries.
  • page, sort: Pagination and sorting options.
  • Other specific filter keys related to device, location, segment, types, etc.

Output

The output is a JSON array containing the response from the Commanders Act API after attempting to destroy the specified cleansing transformation. The structure depends on the API response but typically includes confirmation of deletion or error details.

If the API returns no content (HTTP 204), the output will indicate "Status Code": "204 No Content".

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2.
  • Proper configuration of the API token and site ID credentials is necessary.

Troubleshooting

  • Missing Cleansing Transformation ID: If the required ID is not provided, the node throws an error indicating that the "Cleansing Transformation ID is required".
  • API Authentication Errors: Ensure that the API token credential is correctly set up; otherwise, the node will throw a missing credentials error.
  • Invalid or Nonexistent ID: If the ID does not correspond to an existing cleansing transformation, the API may return an error which will be surfaced by the node.
  • Network or API Errors: Any issues during the HTTP request will result in an error message prefixed with "Error calling Commanders Act API".

To resolve errors:

  • Verify all required IDs are correctly entered.
  • Check API credentials and permissions.
  • Review network connectivity and API endpoint availability.

Links and References

Discussion