Crownpeak DQM icon

Crownpeak DQM

Interact with Crownpeak DQM CMS API

Overview

The node integrates with the Crownpeak DQM CMS API to perform various operations related to website content quality management. Specifically, for the "Get Website Details" operation, it retrieves detailed information about a specified website managed within Crownpeak DQM.

This node is beneficial in scenarios where users need to programmatically access metadata or configuration details of websites monitored by Crownpeak DQM, such as for auditing, reporting, or further automated processing workflows.

Example use case:
A user wants to fetch and review the configuration details of a particular website before running quality checks or generating reports on its content status.

Properties

Name Meaning
Website ID The unique identifier of the website for which to retrieve details or checkpoints.

Output

The output is a JSON array containing the response from the Crownpeak DQM API for the requested website details. This typically includes metadata about the website such as its name, ID, status, and other relevant configuration or descriptive fields provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Crownpeak DQM CMS API.
  • The node expects the base URL of the Crownpeak DQM API to be configured in the credentials.
  • Network connectivity to the Crownpeak DQM API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API key can cause authentication failures.
    • Providing an incorrect or non-existent Website ID will result in errors or empty responses.
    • Network issues or incorrect base URL configuration may prevent successful API calls.
  • Error messages:

    • "Unsupported operation": Indicates that the selected operation is not implemented; ensure "Get Website Details" is chosen.
    • HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found) usually indicate credential or parameter issues.
  • Resolutions:

    • Verify the API key and base URL in the node credentials.
    • Confirm the Website ID exists and is correctly entered.
    • Check network connectivity and firewall settings.

Links and References

Discussion