inline-comments

create-inline-comment

Create inline comment

Create an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence.

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

POST /inline-comments

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

cf inline-comments create-inline-comment

delete-inline-comment

Delete inline comment

Deletes an inline comment. This is a permanent deletion and cannot be reverted.

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space.

DELETE /inline-comments/{comment-id}

Flag	Type	Required	Description
--comment-id	string	Yes	The ID of the comment to be deleted.

Example:

cf inline-comments delete-inline-comment --comment-id <comment-id>

get-inline-comment-by-id

Get inline comment by id

Retrieves an inline comment by id

Permissions required: Permission to view the content of the page or blogpost and its corresponding space.

GET /inline-comments/{comment-id}

Flag	Type	Required	Description
--body-format	string	No	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--comment-id	string	Yes	The ID of the comment to be retrieved.
--include-likes	string	No	Includes likes associated with this inline comment in the response.
The number of results will be limited to 50 and sorted in the default sort order.
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.
--include-operations	string	No	Includes operations associated with this inline comment in the response, as defined in the Operation object.
The number of results will be limited to 50 and sorted in the default sort order.
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.
--include-properties	string	No	Includes content properties associated with this inline comment in the response.
The number of results will be limited to 50 and sorted in the default sort order.
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.
--include-version	string	No	Includes the current version associated with this inline comment in the response.
By default this is included and can be omitted by setting the value to false.
--include-versions	string	No	Includes versions associated with this inline comment in the response.
The number of results will be limited to 50 and sorted in the default sort order.
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.
--version	string	No	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

Example:

cf inline-comments get-inline-comment-by-id --comment-id <comment-id>

get-inline-comment-children

Get children inline comments

Returns the children inline comments of specific comment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to view the content of the page and its corresponding space.

GET /inline-comments/{id}/children

Flag	Type	Required	Description
--body-format	string	No	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--id	string	Yes	The ID of the parent comment for which inline comment children should be returned.
--limit	string	No	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
--sort	string	No	Used to sort the result by a particular field.

Example:

cf inline-comments get-inline-comment-children --id <id>

get-inline-comment-operations

Get permitted operations for inline comment

Returns the permitted operations on specific inline comment.

Permissions required: Permission to view the parent content of the inline comment and its corresponding space.

GET /inline-comments/{id}/operations

Flag	Type	Required	Description
--id	string	Yes	The ID of the inline comment for which operations should be returned.

Example:

cf inline-comments get-inline-comment-operations --id <id>

get-inline-comment-version-details

Get version details for inline comment version

Retrieves version details for the specified inline comment version.

Permissions required: Permission to view the content of the page or blog post and its corresponding space.

GET /inline-comments/{id}/versions/{version-number}

Flag	Type	Required	Description
--id	string	Yes	The ID of the inline comment for which version details should be returned.
--version-number	string	Yes	The version number of the inline comment to be returned.

Example:

cf inline-comments get-inline-comment-version-details --id <id> --version-number <version-number>

get-inline-comment-versions

Get inline comment versions

Retrieves the versions of the specified inline comment.

Permissions required: Permission to view the content of the page or blog post and its corresponding space.

GET /inline-comments/{id}/versions

Flag	Type	Required	Description
--body-format	string	No	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--id	string	Yes	The ID of the inline comment for which versions should be returned
--limit	string	No	Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
--sort	string	No	Used to sort the result by a particular field.

Example:

cf inline-comments get-inline-comment-versions --id <id>

get-inline-comments

Get inline comments

Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to view the content of the page and its corresponding space.

GET /inline-comments

Flag	Type	Required	Description
--body-format	string	No	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--limit	string	No	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
--sort	string	No	Used to sort the result by a particular field.

Example:

cf inline-comments get-inline-comments

get-inline-like-count

Get like count for inline comment

Returns the count of likes of specific inline comment.

Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

GET /inline-comments/{id}/likes/count

Flag	Type	Required	Description
--id	string	Yes	The ID of the inline comment for which like count should be returned.

Example:

cf inline-comments get-inline-like-count --id <id>

get-inline-like-users

Get account IDs of likes for inline comment

Returns the account IDs of likes of specific inline comment.

Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

GET /inline-comments/{id}/likes/users

Flag	Type	Required	Description
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--id	string	Yes	The ID of the inline comment for which like count should be returned.
--limit	string	No	Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

Example:

cf inline-comments get-inline-like-users --id <id>

update-inline-comment

Update inline comment

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

PUT /inline-comments/{comment-id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--comment-id	string	Yes	The ID of the comment to be retrieved.

Example:

cf inline-comments update-inline-comment --comment-id <comment-id>