> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # confluence-comments > Confluence Comments **Server path:** `/confluence-comments` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------- | --------------------------------- | | [`confluence-comments_create_footer_comment`](#confluence-comments_create_footer_comment) | Create footer comment | | [`confluence-comments_create_inline_comment`](#confluence-comments_create_inline_comment) | Create inline comment | | [`confluence-comments_delete_footer_comment`](#confluence-comments_delete_footer_comment) | Delete footer comment | | [`confluence-comments_delete_inline_comment`](#confluence-comments_delete_inline_comment) | Delete inline comment | | [`confluence-comments_get_attachment_comments`](#confluence-comments_get_attachment_comments) | Get attachment comments | | [`confluence-comments_get_blog_post_footer_comments`](#confluence-comments_get_blog_post_footer_comments) | Get footer comments for blog post | | [`confluence-comments_get_blog_post_inline_comments`](#confluence-comments_get_blog_post_inline_comments) | Get inline comments for blog post | | [`confluence-comments_get_footer_comment_by_id`](#confluence-comments_get_footer_comment_by_id) | Get footer comment by id | | [`confluence-comments_get_footer_comment_children`](#confluence-comments_get_footer_comment_children) | Get children footer comments | | [`confluence-comments_get_footer_comments`](#confluence-comments_get_footer_comments) | Get footer comments | | [`confluence-comments_get_inline_comment_by_id`](#confluence-comments_get_inline_comment_by_id) | Get inline comment by id | | [`confluence-comments_get_inline_comment_children`](#confluence-comments_get_inline_comment_children) | Get children inline comments | | [`confluence-comments_get_inline_comments`](#confluence-comments_get_inline_comments) | Get inline comments | | [`confluence-comments_get_page_footer_comments`](#confluence-comments_get_page_footer_comments) | Get footer comments for page | | [`confluence-comments_get_page_inline_comments`](#confluence-comments_get_page_inline_comments) | Get inline comments for page | | [`confluence-comments_get_task_by_id`](#confluence-comments_get_task_by_id) | Get task by id | | [`confluence-comments_get_tasks`](#confluence-comments_get_tasks) | Get tasks | | [`confluence-comments_update_footer_comment`](#confluence-comments_update_footer_comment) | Update footer comment | | [`confluence-comments_update_inline_comment`](#confluence-comments_update_inline_comment) | Update inline comment | | [`confluence-comments_update_task`](#confluence-comments_update_task) | Update task | *** ## confluence-comments\_create\_footer\_comment Create footer comment **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | | `attachmentId` | string | No | — | ID of the attachment, if intending to create a comment against an attachment. | | `blogPostId` | string | No | — | ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply. | | `body` | object | Yes | — | The body value | | `customContentId` | string | No | — | ID of the custom content, if intending to create a comment against a custom content. | | `pageId` | string | No | — | ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply. | | `parentCommentId` | string | No | — | ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachmentId": { "type": "string", "description": "ID of the attachment, if intending to create a comment against an attachment." }, "blogPostId": { "type": "string", "description": "ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply." }, "body": { "type": "object", "description": "The body value", "properties": { "representation": { "type": "string", "description": "Type of content representation used for the value field.", "enum": [ "storage", "atlas_doc_format", "wiki" ] }, "value": { "type": "string", "description": "Body of the comment, in the format found in the representation field." } } }, "customContentId": { "type": "string", "description": "ID of the custom content, if intending to create a comment against a custom content." }, "pageId": { "type": "string", "description": "ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply." }, "parentCommentId": { "type": "string", "description": "ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment." } }, "required": [ "PCID", "body" ] } ``` *** ## confluence-comments\_create\_inline\_comment Create inline comment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `blogPostId` | string | No | — | ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply. | | `body` | object | Yes | — | The body value | | `inlineCommentProperties` | object | No | — | Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case. | | `pageId` | string | No | — | ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply. | | `parentCommentId` | string | No | — | ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "blogPostId": { "type": "string", "description": "ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply." }, "body": { "type": "object", "description": "The body value", "properties": { "representation": { "type": "string", "description": "Type of content representation used for the value field.", "enum": [ "storage", "atlas_doc_format", "wiki" ] }, "value": { "type": "string", "description": "Body of the comment, in the format found in the representation field." } } }, "inlineCommentProperties": { "type": "object", "description": "Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case.", "properties": { "textSelection": { "type": "string", "description": "The text to highlight" }, "textSelectionMatchCount": { "type": "integer", "description": "The number of matches for the selected text on the page (should be strictly greater than textSelectionMatchIndex)" }, "textSelectionMatchIndex": { "type": "integer", "description": "The match index to highlight. This is zero-based. E.g. if you have 3 occurrences of \"hello world\" on a page and you want to highlight the second occurrence, you should pass 1 for textSelectionMatchIndex and 3 for textSelectionMatchCount." } } }, "pageId": { "type": "string", "description": "ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply." }, "parentCommentId": { "type": "string", "description": "ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment." } }, "required": [ "PCID", "body" ] } ``` *** ## confluence-comments\_delete\_footer\_comment Delete footer comment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------------------- | | `comment-id` | integer | Yes | — | The ID of the comment to be retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be retrieved." } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_delete\_inline\_comment Delete inline comment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------ | | `comment-id` | integer | Yes | — | The ID of the comment to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be deleted." } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_get\_attachment\_comments Get attachment comments **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The ID of the attachment for which comments should be returned. | | `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` | integer | No | — | Maximum number of 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. | | `contentVersion` | integer | No | — | Version number of the attachment to retrieve comments for. If no version provided, retrieves comments for the latest version. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the attachment for which comments should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "Maximum number of 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": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "contentVersion": { "type": "integer", "description": "Version number of the attachment to retrieve comments for. If no version provided, retrieves comments for the latest version." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_blog\_post\_footer\_comments Get footer comments for blog post **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the blog post for which footer comments should be returned. | | `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. | | `status` | string\[] | No | — | Filter the footer comment being retrieved by its status. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the blog post for which footer comments should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "status": { "type": "array", "items": { "type": "string", "enum": [ "current", "deleted", "trashed", "historical", "draft" ] }, "description": "Filter the footer comment being retrieved by its status." }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_blog\_post\_inline\_comments Get inline comments for blog post **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the blog post for which inline comments should be returned. | | `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. | | `status` | string\[] | No | — | Filter the inline comment being retrieved by its status. | | `resolution-status` | string\[] | No | — | Filter the inline comment being retrieved by its resolution status. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | No | — | Maximum number of inline 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the blog post for which inline comments should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "status": { "type": "array", "items": { "type": "string", "enum": [ "current", "deleted", "trashed", "historical", "draft" ] }, "description": "Filter the inline comment being retrieved by its status." }, "resolution-status": { "type": "array", "items": { "type": "string", "enum": [ "resolved", "open", "dangling", "reopened" ] }, "description": "Filter the inline comment being retrieved by its resolution status." }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "Maximum number of inline 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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_footer\_comment\_by\_id Get footer comment by id **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `comment-id` | integer | Yes | — | The ID of the comment to be retrieved. | | `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. | | `contentVersion` | integer | No | — | Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. | | `include-properties` | boolean | No | — | Includes content properties associated with this footer 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` | boolean | No | — | Includes operations associated with this footer 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-likes` | boolean | No | — | Includes likes associated with this footer 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-versions` | boolean | No | — | Includes versions associated with this footer 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` | boolean | No | — | Includes the current version associated with this footer comment in the response. By default this is included and can be omitted by setting the value to `false`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be retrieved." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format", "view", "export_view", "anonymous_export_view", "styled_view", "editor" ] }, "contentVersion": { "type": "integer", "description": "Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details." }, "include-properties": { "type": "boolean", "description": "Includes content properties associated with this footer 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": { "type": "boolean", "description": "Includes operations associated with this footer 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-likes": { "type": "boolean", "description": "Includes likes associated with this footer 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-versions": { "type": "boolean", "description": "Includes versions associated with this footer 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": { "type": "boolean", "description": "Includes the current version associated with this footer comment in the response. By default this is included and can be omitted by setting the value to `false`." } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_get\_footer\_comment\_children Get children footer comments **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the parent comment for which footer comment children should be returned. | | `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. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the parent comment for which footer comment children should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_footer\_comments Get footer comments **Parameters:** | Parameter | Type | Required | Default | 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. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## confluence-comments\_get\_inline\_comment\_by\_id Get inline comment by id **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `comment-id` | integer | Yes | — | The ID of the comment to be retrieved. | | `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. | | `contentVersion` | integer | No | — | Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. | | `include-properties` | boolean | 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-operations` | boolean | 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-likes` | boolean | 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-versions` | boolean | 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. | | `include-version` | boolean | 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be retrieved." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format", "view", "export_view", "anonymous_export_view", "styled_view", "editor" ] }, "contentVersion": { "type": "integer", "description": "Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details." }, "include-properties": { "type": "boolean", "description": "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-operations": { "type": "boolean", "description": "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-likes": { "type": "boolean", "description": "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-versions": { "type": "boolean", "description": "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." }, "include-version": { "type": "boolean", "description": "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`." } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_get\_inline\_comment\_children Get children inline comments **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the parent comment for which inline comment children should be returned. | | `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. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the parent comment for which inline comment children should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_inline\_comments Get inline comments **Parameters:** | Parameter | Type | Required | Default | 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. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## confluence-comments\_get\_page\_footer\_comments Get footer comments for page **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the page for which footer comments should be returned. | | `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. | | `status` | string\[] | No | — | Filter the footer comment being retrieved by its status. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the page for which footer comments should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "status": { "type": "array", "items": { "type": "string", "enum": [ "current", "archived", "trashed", "deleted", "historical", "draft" ] }, "description": "Filter the footer comment being retrieved by its status." }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_page\_inline\_comments Get inline comments for page **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the page for which inline comments should be returned. | | `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. | | `status` | string\[] | No | — | Filter the inline comment being retrieved by its status. | | `resolution-status` | string\[] | No | — | Filter the inline comment being retrieved by its resolution status. | | `sort` | string | No | — | Used to sort the result by a particular 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` | integer | No | — | Maximum number of inline 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the page for which inline comments should be returned." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "status": { "type": "array", "items": { "type": "string", "enum": [ "current", "archived", "trashed", "deleted", "historical", "draft" ] }, "description": "Filter the inline comment being retrieved by its status." }, "resolution-status": { "type": "array", "items": { "type": "string", "enum": [ "resolved", "open", "dangling", "reopened" ] }, "description": "Filter the inline comment being retrieved by its resolution status." }, "sort": { "type": "string", "description": "Used to sort the result by a particular field.", "enum": [ "created-date", "-created-date", "modified-date", "-modified-date" ] }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "Maximum number of inline 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." } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_task\_by\_id Get task by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] } }, "required": [ "PCID", "id" ] } ``` *** ## confluence-comments\_get\_tasks Get tasks **Parameters:** | Parameter | Type | Required | Default | 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. | | `include-blank-tasks` | boolean | No | — | Specifies whether to include blank tasks in the response. Defaults to `true`. | | `status` | string | No | — | Filters on the status of the task. | | `task-id` | integer\[] | No | — | Filters on task ID. Multiple IDs can be specified. | | `space-id` | integer\[] | No | — | Filters on the space ID of the task. Multiple IDs can be specified. | | `page-id` | integer\[] | No | — | Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. | | `blogpost-id` | integer\[] | No | — | Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. | | `created-by` | string\[] | No | — | Filters on the Account ID of the user who created this task. Multiple IDs can be specified. | | `assigned-to` | string\[] | No | — | Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified. | | `completed-by` | string\[] | No | — | Filters on the Account ID of the user who completed this task. Multiple IDs can be specified. | | `created-at-from` | integer | No | — | Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. | | `created-at-to` | integer | No | — | Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. | | `due-at-from` | integer | No | — | Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. | | `due-at-to` | integer | No | — | Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. | | `completed-at-from` | integer | No | — | Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. | | `completed-at-to` | integer | No | — | Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. | | `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` | integer | No | — | Maximum number of tasks 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "include-blank-tasks": { "type": "boolean", "description": "Specifies whether to include blank tasks in the response. Defaults to `true`." }, "status": { "type": "string", "description": "Filters on the status of the task.", "enum": [ "complete", "incomplete" ] }, "task-id": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filters on task ID. Multiple IDs can be specified." }, "space-id": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filters on the space ID of the task. Multiple IDs can be specified." }, "page-id": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction." }, "blogpost-id": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction." }, "created-by": { "type": "array", "items": { "type": "string" }, "description": "Filters on the Account ID of the user who created this task. Multiple IDs can be specified." }, "assigned-to": { "type": "array", "items": { "type": "string" }, "description": "Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified." }, "completed-by": { "type": "array", "items": { "type": "string" }, "description": "Filters on the Account ID of the user who completed this task. Multiple IDs can be specified." }, "created-at-from": { "type": "integer", "description": "Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds." }, "created-at-to": { "type": "integer", "description": "Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds." }, "due-at-from": { "type": "integer", "description": "Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds." }, "due-at-to": { "type": "integer", "description": "Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds." }, "completed-at-from": { "type": "integer", "description": "Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds." }, "completed-at-to": { "type": "integer", "description": "Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds." }, "cursor": { "type": "string", "description": "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": { "type": "integer", "description": "Maximum number of tasks 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." } }, "required": [ "PCID" ] } ``` *** ## confluence-comments\_update\_footer\_comment Update footer comment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------------------- | | `comment-id` | integer | Yes | — | The ID of the comment to be retrieved. | | `_links` | object | No | — | The links value | | `body` | object | No | — | The body value | | `contentVersion` | object | No | — | Content Version | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be retrieved." }, "_links": { "type": "object", "description": "The links value", "properties": { "base": { "type": "string", "description": "Base url of the Confluence site." } } }, "body": { "type": "object", "description": "The body value", "properties": { "representation": { "type": "string", "description": "Type of content representation used for the value field.", "enum": [ "storage", "atlas_doc_format", "wiki" ] }, "value": { "type": "string", "description": "Body of the comment, in the format found in the representation field." } } }, "contentVersion": { "type": "object", "description": "Content Version", "properties": { "number": { "type": "integer", "description": "Number of new version. Should be 1 higher than current version of the comment." }, "message": { "type": "string", "description": "Optional message store for the new version." } } } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_update\_inline\_comment Update inline comment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `comment-id` | integer | Yes | — | The ID of the comment to be retrieved. | | `body` | object | No | — | The body value | | `resolved` | boolean | No | — | Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If matching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling comment cannot be updated. | | `contentVersion` | object | No | — | Content Version | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment-id": { "type": "integer", "description": "The ID of the comment to be retrieved." }, "body": { "type": "object", "description": "The body value", "properties": { "representation": { "type": "string", "description": "Type of content representation used for the value field.", "enum": [ "storage", "atlas_doc_format", "wiki" ] }, "value": { "type": "string", "description": "Body of the comment, in the format found in the representation field." } } }, "resolved": { "type": "boolean", "description": "Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If matching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling comment cannot be updated." }, "contentVersion": { "type": "object", "description": "Content Version", "properties": { "number": { "type": "integer", "description": "Number of new version. Should be 1 higher than current version of the comment." }, "message": { "type": "string", "description": "Optional message store for the new version." } } } }, "required": [ "PCID", "comment-id" ] } ``` *** ## confluence-comments\_update\_task Update task **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results. | | `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. | | `assignedTo` | string | No | — | Account ID of the user to whom this task is assigned. | | `blogPostId` | string | No | — | ID of the blog post the task is in. | | `completedAt` | string | No | — | Date and time when the task was completed. In format "YYYY-MM-DDTHH:mm:ss.sssZ". | | `completedBy` | string | No | — | Account ID of the user who completed this task. | | `createdAt` | string | No | — | Date and time when the task was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ". | | `createdBy` | string | No | — | Account ID of the user who created this task. | | `dueAt` | string | No | — | Date and time when the task is due. In format "YYYY-MM-DDTHH:mm:ss.sssZ". | | `localId` | string | No | — | Local ID of the task. This ID is local to the corresponding page or blog post. | | `pageId` | string | No | — | ID of the page the task is in. | | `spaceId` | string | No | — | ID of the space the task is in. | | `status` | string | Yes | — | Status of the task. | | `updatedAt` | string | No | — | Date and time when the task was updated. In format "YYYY-MM-DDTHH:mm:ss.sssZ". | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results." }, "body-format": { "type": "string", "description": "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.", "enum": [ "storage", "atlas_doc_format" ] }, "assignedTo": { "type": "string", "description": "Account ID of the user to whom this task is assigned." }, "blogPostId": { "type": "string", "description": "ID of the blog post the task is in." }, "completedAt": { "type": "string", "description": "Date and time when the task was completed. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"." }, "completedBy": { "type": "string", "description": "Account ID of the user who completed this task." }, "createdAt": { "type": "string", "description": "Date and time when the task was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"." }, "createdBy": { "type": "string", "description": "Account ID of the user who created this task." }, "dueAt": { "type": "string", "description": "Date and time when the task is due. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"." }, "localId": { "type": "string", "description": "Local ID of the task. This ID is local to the corresponding page or blog post." }, "pageId": { "type": "string", "description": "ID of the page the task is in." }, "spaceId": { "type": "string", "description": "ID of the space the task is in." }, "status": { "type": "string", "description": "Status of the task.", "enum": [ "complete", "incomplete" ] }, "updatedAt": { "type": "string", "description": "Date and time when the task was updated. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"." } }, "required": [ "PCID", "id", "status" ] } ```