Confluence Cloud icon

Confluence Cloud

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

Overview

This node operation retrieves the root inline comments of a specific blog post from Confluence Cloud. It is useful when you want to programmatically access all inline comments associated with a particular blog post, for example, to analyze feedback, track discussions, or integrate comment data into other workflows or reporting tools.

Practical examples:

  • Extracting all inline comments on a blog post to summarize user feedback.
  • Monitoring unresolved inline comments by filtering based on resolution status.
  • Exporting inline comments for archival or audit purposes.

Properties

Name Meaning
Id The ID of the blog post for which inline comments should be returned. This is a required numeric identifier.
Additional Fields Optional additional parameters to refine the request:
- Body Format: The content format type to be returned in the body field of each comment (e.g., storage, view).
- Status: Filter inline comments by their status. Possible values: Current, Deleted, Trashed, Historical, Draft.
- Resolution Status: Filter inline comments by their resolution status. Possible values: Resolved, Open, Dangling, Reopened.
- Sort: Specify a field to sort the results by.

Output

The output JSON contains an array of inline comment objects related to the specified blog post. Each comment object includes details such as the comment body (in the requested format), status, resolution status, author information, timestamps, and potentially nested replies if applicable.

If binary data were involved (not in this operation), it would typically represent attachments or media related to comments, but this operation focuses solely on JSON comment data.

Dependencies

  • Requires an authenticated connection to Confluence Cloud via an API key credential.
  • The node must be configured with the Confluence Cloud domain and appropriate API authentication credentials.
  • Permissions: The user must have permission to view the blog post and its space to retrieve inline comments.

Troubleshooting

  • Common issues:

    • Invalid or missing blog post ID will result in errors or empty responses.
    • Insufficient permissions to view the blog post or comments will cause authorization errors.
    • Incorrect or unsupported body format values may lead to unexpected response formats or errors.
  • Error messages:

    • "Permission denied" or similar indicates lack of access rights; ensure the API token has sufficient permissions.
    • "Resource not found" usually means the blog post ID does not exist or is inaccessible.
    • "Invalid parameter" errors can occur if filters like status or resolution-status contain unsupported values; verify input options.

Links and References

Discussion