Confluence Cloud icon

Confluence Cloud

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

Actions35

Overview

This node operation retrieves a specific inline comment from Confluence Cloud by its unique Comment ID. Inline comments are annotations tied to specific text selections within pages or blog posts, allowing users to discuss or provide feedback directly on content segments.

Typical use cases include:

  • Fetching detailed information about a particular inline comment for review or processing.
  • Integrating comment data into workflows that track user feedback or content discussions.
  • Auditing or exporting inline comments for documentation or analysis purposes.

For example, you might use this node to get the details of an inline comment to display it in a custom dashboard or to trigger notifications based on comment content or status.

Properties

Name Meaning
Comment Id The unique numeric identifier of the inline comment to retrieve.
Additional Fields A collection of optional parameters to customize the response:
- Body Format The format type for the comment's body content (e.g., storage, view). If specified, the response will include the body in this format.
- Version Retrieve a previously published version of the comment by specifying its version number.
- Include Properties Whether to include content properties associated with this inline comment in the response. Limited to 50 results with pagination info if more exist.
- Include Operations Whether to include operations associated with this inline comment as defined in the Operation object. Also limited to 50 results with pagination info.
- Include Likes Whether to include likes associated with this inline comment. Limited to 50 results with pagination info.
- Include Versions Whether to include versions associated with this inline comment. Limited to 50 results with pagination info.
- Include Version Whether to include the current version associated with this inline comment. Defaults to true; can be omitted by setting to false.

Output

The output JSON contains the detailed data of the requested inline comment, including fields such as:

  • The comment's unique ID and metadata.
  • The body content of the comment in the requested format.
  • Associated properties, operations, likes, and versions if requested via additional fields.
  • Pagination metadata (meta and _links) when multiple related items (like properties or versions) are included and exceed the limit.

No binary data is output by this operation.

Dependencies

  • Requires access to a Confluence Cloud instance with appropriate API credentials (an API key or token).
  • The node must be configured with valid authentication credentials to the Confluence Cloud REST API.
  • Permissions required: The authenticated user must have permission to view the content of the page or blog post where the inline comment exists.

Troubleshooting

  • Permission errors: If the node returns authorization errors, verify that the API credentials have sufficient permissions to view the target content and comments.
  • Invalid Comment Id: Providing a non-existent or incorrect comment ID will result in a "not found" error. Double-check the ID value.
  • Version not found: Specifying a version number that does not exist for the comment may cause an error or empty response.
  • API rate limits: Excessive requests may hit Confluence API rate limits; consider adding delays or handling retries.
  • Pagination issues: When including properties, operations, likes, or versions, only up to 50 items are returned per request. Use pagination links if more data is needed.

Links and References

Discussion