Confluence Cloud icon

Confluence Cloud

Zugriff auf die Confluence Cloud REST API - Auto-generated from OpenAPI

Actions35

Overview

This node operation retrieves comments associated with a specific custom content item in Confluence Cloud. It is useful when you want to fetch all comments made on a particular piece of custom content, such as feedback or discussion notes related to that content.

Typical use cases include:

  • Aggregating user comments for review or analysis.
  • Displaying comment threads related to custom content in external dashboards or applications.
  • Automating workflows based on comment activity on custom content.

For example, if you have a custom content item representing a project document, this operation can fetch all comments users have made on it, enabling you to process or display them elsewhere.

Properties

Name Meaning
Id The ID of the custom content for which comments should be returned. This is required to specify the target content.
Additional Fields Optional parameters to customize the request:
- Body Format: The format type for the comment body content returned (e.g., storage, view).
- Sort: Field by which to sort the returned comments (e.g., creation date).

Output

The output will be a JSON object containing the list of comments for the specified custom content. The main data will be under a property typically named results (based on common API response patterns), each entry representing a comment with its details such as author, body, creation date, and possibly formatted body content depending on the body-format parameter.

No binary data output is expected from this operation.

Dependencies

  • Requires an authenticated connection to Confluence Cloud via an API key credential.
  • The node must be configured with the domain URL of the Confluence Cloud instance.
  • Permissions: The user associated with the API key must have permission to view the custom content and its containers to retrieve comments.

Troubleshooting

  • Permission errors: If the node returns authorization errors, verify that the API key has sufficient permissions to access the custom content and read comments.
  • Invalid ID: Providing an incorrect or non-existent custom content ID will result in no comments or an error. Ensure the ID is correct.
  • Empty results: If no comments are returned, confirm that the custom content actually has comments and that filters (like status or sort) are not excluding them.
  • Unsupported body format: Specifying an unsupported body-format may cause the API to ignore the parameter or return default formatting.

Links and References

Discussion