Confluence — это мощная платформа Atlassian для совместной работы команд и управления знаниями. Она служит централизованной рабочей областью, где команды могут создавать, организовывать и делиться информацией между отделами и организациями.
С помощью Confluence вы можете:
- Создавать структурированную документацию: Создавайте комплексные вики, планы проектов и базы знаний с богатым форматированием
- Совместно работать в реальном времени: Работайте вместе над документами с коллегами, с комментариями, упоминаниями и возможностями редактирования
- Организовывать информацию иерархически: Структурируйте контент с помощью пространств, страниц и вложенных иерархий для интуитивной навигации
- Интегрировать с другими инструментами: Подключайтесь к Jira, Trello и другим продуктам Atlassian для бесшовной интеграции рабочих процессов
- Контролировать права доступа: Управляйте тем, кто может просматривать, редактировать или комментировать определенный контент
В AACFlow интеграция с Confluence позволяет вашим агентам получать доступ к базе знаний вашей организации и использовать её. Агенты могут извлекать информацию со страниц Confluence, искать определенный контент и даже обновлять документацию при необходимости. Это позволяет вашим рабочим процессам включать коллективные знания, хранящиеся в вашем экземпляре Confluence, что делает возможным создание агентов, которые могут ссылаться на внутреннюю документацию, следовать установленным процедурам и поддерживать актуальные информационные ресурсы в рамках своей работы.
Интегрируйте Confluence в рабочий процесс. Может читать, создавать, обновлять, удалять страницы, управлять комментариями, вложениями, метками и искать контент.
Получить контент со страниц Confluence с помощью Confluence API.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для получения \(числовой ID из URL страницы или API\) |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | Метка времени ISO 8601 операции |
pageId | string | ID страницы Confluence |
title | string | Заголовок страницы |
content | string | Содержимое страницы с удаленными HTML-тегами |
status | string | Статус страницы \(current, archived, trashed, draft\) |
spaceId | string | ID пространства, содержащего страницу |
parentId | string | ID родительской страницы |
authorId | string | Account ID автора страницы |
createdAt | string | Метка времени ISO 8601 создания страницы |
url | string | URL для просмотра страницы в Confluence |
body | object | Сырое содержимое тела страницы в формате хранения |
↳ value | string | Значение контента в указанном формате |
↳ representation | string | Тип представления контента |
version | object | Информация о версии страницы |
↳ number | number | Номер версии |
↳ message | string | Сообщение версии |
↳ minorEdit | boolean | Является ли это незначительным редактированием |
↳ authorId | string | Account ID автора версии |
↳ createdAt | string | Метка времени ISO 8601 создания версии |
Обновить страницу Confluence с помощью Confluence API.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для обновления \(числовой ID из URL страницы или API\) |
title | string | Нет | Новый заголовок для страницы |
content | string | Нет | Новое содержимое для страницы в формате хранения Confluence |
version | number | Нет | Номер версии страницы \(требуется для предотвращения конфликтов\) |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | Метка времени обновления |
pageId | string | ID страницы Confluence |
title | string | Обновленный заголовок страницы |
status | string | Статус страницы |
spaceId | string | ID пространства |
body | object | Содержимое тела страницы в формате хранения |
↳ storage | object | Тело в формате хранения \(разметка Confluence\) |
↳ value | string | Значение контента в указанном формате |
↳ representation | string | Тип представления контента |
↳ view | object | Тело в формате просмотра \(отрендеренный HTML\) |
↳ value | string | Значение контента в указанном формате |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
url | string | URL to view the page in Confluence |
success | boolean | Update operation success status |
Создать новый page in a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | ID пространства Confluence, где будет расположена страница created |
title | string | Да | Title of the new page |
content | string | Да | Page content in Confluence storage format (HTML) |
parentId | string | Нет | Parent page ID if creating a child page |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of creation |
pageId | string | Created page ID |
title | string | Page title |
status | string | Page status |
spaceId | string | Space ID |
parentId | string | Parent page ID |
body | object | Page body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
url | string | Page URL |
Удалить страницу Confluence. По умолчанию moves to trash; use purge=true to permanently delete.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | Confluence page ID to delete |
purge | boolean | Нет | If true, permanently deletes the page instead of moving to trash (default: false) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of deletion |
pageId | string | Deleted page ID |
deleted | boolean | Deletion status |
Список всех pages within a specific Confluence space. Supports постраничная выборка и фильтрация by status.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | The ID of the Confluence space to list pages from |
limit | number | Нет | Maximum number of pages to return (default: 50, max: 250) |
status | string | Нет | Filter pages by status: current, archived, trashed, or draft |
bodyFormat | string | Нет | Format for page body content: storage, atlas_doc_format, or view. If not specified, body is not included. |
cursor | string | Нет | Pagination cursor from previous response to get the next page of results |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pages | array | Массив pages in the space |
↳ id | string | Unique page identifier |
↳ title | string | Page title |
↳ status | string | Page status (e.g., current, archived, trashed, draft) |
↳ spaceId | string | ID of the space containing the page |
↳ parentId | string | ID of the parent page (null if top-level) |
↳ authorId | string | Account ID of the page author |
↳ createdAt | string | ISO 8601 timestamp when the page was created |
↳ version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ body | object | Page body content (if bodyFormat was specified) |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ webUrl | string | URL to view the page in Confluence |
nextCursor | string | Cursor for fetching the next page of results |
Получить все child pages of a specific Confluence page. Useful для navigating page hierarchies.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the parent page to get children from |
limit | number | Нет | Maximum number of child pages to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response to get the next page of results |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
parentId | string | ID of the parent page |
children | array | Массив child pages |
↳ id | string | Child page ID |
↳ title | string | Child page title |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ childPosition | number | Position among siblings |
↳ webUrl | string | URL to view the page |
nextCursor | string | Cursor for fetching the next page of results |
Получить родительские страницы определённой страницы Confluence. Возвращает the full hierarchy from the page up to the root.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page to get ancestors for |
limit | number | Нет | Maximum number of ancestors to return (default: 25, max: 250) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page whose ancestors were retrieved |
ancestors | array | Массив ancestor pages, ordered from direct parent to root |
↳ id | string | Ancestor page ID |
↳ title | string | Ancestor page title |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ webUrl | string | URL to view the page |
Список всех versions (revision history) of a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page to get versions for |
limit | number | Нет | Maximum number of versions to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
versions | array | Массив page versions |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
Получить details about a specific version of a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page |
versionNumber | number | Да | The version number to retrieve (e.g., 1, 2, 3) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
title | string | Page title at this version |
content | string | Page content with HTML tags stripped at this version |
version | object | Detailed version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ contentTypeModified | boolean | Произошла ли content type was modified in this version |
↳ collaborators | array | List of collaborator account IDs for this version |
↳ prevVersion | number | Previous version number |
↳ nextVersion | number | Next version number |
body | object | Raw page body content in storage format at this version |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
Список всех custom properties (metadata) attached to a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page to list properties from |
limit | number | Нет | Maximum number of properties to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
properties | array | Массив content properties |
↳ id | string | Property ID |
↳ key | string | Property key |
↳ value | json | Property value (can be any JSON) |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
Создать новый custom property (metadata) on a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page to add the property to |
key | string | Да | The key/name for the property |
value | json | Да | The value for the property (can be any JSON value) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
propertyId | string | ID of the created property |
key | string | Property key |
value | json | Property value |
version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
Удалить content property from a Confluence page by its property ID.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | The ID of the page containing the property |
propertyId | string | Да | The ID of the property to delete |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
propertyId | string | ID of the deleted property |
deleted | boolean | Deletion status |
Поиск content across Confluence pages, blog posts, и other content.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
query | string | Да | Search query string |
limit | number | Нет | Maximum number of results to return (default: 25) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of search |
results | array | Массив search results |
↳ id | string | Unique content identifier |
↳ title | string | Content title |
↳ type | string | Content type (e.g., page, blogpost, attachment, comment) |
↳ status | string | Content status (e.g., current) |
↳ url | string | URL to view the content in Confluence |
↳ excerpt | string | Text excerpt matching the search query |
↳ spaceKey | string | Key of the space containing the content |
↳ space | object | Space information for the content |
↳ id | string | Space identifier |
↳ key | string | Space key |
↳ name | string | Space name |
↳ lastModified | string | ISO 8601 timestamp of last modification |
↳ entityType | string | Entity type identifier (e.g., content, space) |
Поиск content within a specific Confluence space. Optionally filter by text запрос и content type.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceKey | string | Да | The key of the Confluence space to search in (e.g., "ENG", "HR") |
query | string | Нет | Text search query. Если не предоставлен, returns all content in the space. |
contentType | string | Нет | Filter by content type: page, blogpost, attachment, or comment |
limit | number | Нет | Maximum number of results to return (default: 25, max: 250) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceKey | string | The space key that was searched |
totalSize | number | Total number of matching results |
results | array | Массив search results |
↳ id | string | Unique content identifier |
↳ title | string | Content title |
↳ type | string | Content type (e.g., page, blogpost, attachment, comment) |
↳ status | string | Content status (e.g., current) |
↳ url | string | URL to view the content in Confluence |
↳ excerpt | string | Text excerpt matching the search query |
↳ spaceKey | string | Key of the space containing the content |
↳ space | object | Space information for the content |
↳ id | string | Space identifier |
↳ key | string | Space key |
↳ name | string | Space name |
↳ lastModified | string | ISO 8601 timestamp of last modification |
↳ entityType | string | Entity type identifier (e.g., content, space) |
Список всех blog posts across all accessible Confluence spaces.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
limit | number | Нет | Maximum number of blog posts to return (default: 25, max: 250) |
status | string | Нет | Filter by status: current, archived, trashed, or draft |
sort | string | Нет | Sort order: created-date, -created-date, modified-date, -modified-date, title, -title |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPosts | array | Массив blog posts |
↳ id | string | Blog post ID |
↳ title | string | Blog post title |
↳ status | string | Blog post status |
↳ spaceId | string | Space ID |
↳ authorId | string | Author account ID |
↳ createdAt | string | Creation timestamp |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ webUrl | string | URL to view the blog post |
nextCursor | string | Cursor for fetching the next page of results |
Получить a specific Confluence blog post от ID, including its content.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
blogPostId | string | Да | The ID of the blog post to retrieve |
bodyFormat | string | Нет | Format for blog post body: storage, atlas_doc_format, or view |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
authorId | string | Author account ID |
createdAt | string | Creation timestamp |
version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
body | object | Blog post body content in requested format(s) |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
webUrl | string | URL to view the blog post |
Создать новый blog post in a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | The ID of the space to create the blog post in |
title | string | Да | Title of the blog post |
content | string | Да | Blog post content in Confluence storage format (HTML) |
status | string | Нет | Blog post status: current (default) or draft |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Created blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
authorId | string | Author account ID |
body | object | Blog post body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Blog post version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
webUrl | string | URL to view the blog post |
Список всех blog posts within a specific Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | The ID of the Confluence space to list blog posts from |
limit | number | Нет | Maximum number of blog posts to return (default: 25, max: 250) |
status | string | Нет | Filter by status: current, archived, trashed, or draft |
bodyFormat | string | Нет | Format for blog post body: storage, atlas_doc_format, or view |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPosts | array | Массив blog posts in the space |
↳ id | string | Blog post ID |
↳ title | string | Blog post title |
↳ status | string | Blog post status |
↳ spaceId | string | Space ID |
↳ authorId | string | Author account ID |
↳ createdAt | string | Creation timestamp |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ body | object | Blog post body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ webUrl | string | URL to view the blog post |
nextCursor | string | Cursor for fetching the next page of results |
Добавить комментарий to a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | Confluence page ID to comment on |
comment | string | Да | Comment text in Confluence storage format |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of creation |
commentId | string | Created comment ID |
pageId | string | Page ID |
Список всех comments on a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | Confluence page ID to list comments from |
limit | number | Нет | Maximum number of comments to return (default: 25) |
bodyFormat | string | Нет | Format for the comment body: storage, atlas_doc_format, view, or export_view (default: storage) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
comments | array | Массив Confluence comments |
↳ id | string | Unique comment identifier |
↳ status | string | Comment status (e.g., current) |
↳ title | string | Comment title |
↳ pageId | string | ID of the page the comment belongs to |
↳ blogPostId | string | ID of the blog post the comment belongs to |
↳ parentCommentId | string | ID of the parent comment |
↳ body | object | Comment body content |
↳ value | string | Comment body content |
↳ representation | string | Content representation format (e.g., storage, view) |
↳ createdAt | string | ISO 8601 timestamp when the comment was created |
↳ authorId | string | Account ID of the comment author |
↳ version | object | Comment version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Произошла ли эта is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
Обновитьn existing comment on a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
commentId | string | Да | Confluence comment ID to update |
comment | string | Да | Updated comment text in Confluence storage format |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of update |
commentId | string | Updated comment ID |
updated | boolean | Update status |
Удалить comment from a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
commentId | string | Да | Confluence comment ID to delete |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | Timestamp of deletion |
commentId | string | Deleted comment ID |
deleted | boolean | Deletion status |
Загрузить a file as an attachment to a Confluence page.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для получения вложений |
limit | number | Нет | Максимальное количество возвращаемых вложений \(по умолчанию: 50, максимум: 250\) |
cursor | string | Нет | Курсор пагинации из предыдущего ответа |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 метка времени операции |
attachments | array | Массив вложений Confluence |
↳ id | string | Уникальный идентификатор вложения \(с префиксом "att"\) |
↳ title | string | Имя файла вложения |
↳ status | string | Статус вложения \(например, current, archived, trashed\) |
↳ mediaType | string | MIME-тип вложения |
↳ fileSize | number | Размер файла в байтах |
↳ downloadUrl | string | URL для загрузки вложения |
↳ webuiUrl | string | URL для просмотра вложения в интерфейсе Confluence |
↳ pageId | string | ID страницы, к которой принадлежит вложение |
↳ blogPostId | string | ID записи блога, к которой принадлежит вложение |
↳ comment | string | Комментарий/описание вложения |
↳ version | object | Информация о версии вложения |
↳ number | number | Номер версии |
↳ message | string | Сообщение версии |
↳ minorEdit | boolean | Является ли это незначительным редактированием |
↳ authorId | string | Account ID автора версии |
↳ createdAt | string | ISO 8601 метка времени создания версии |
nextCursor | string | Курсор для получения следующей страницы результатов |
Удалить вложение со страницы Confluence (перемещает в корзину).
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
attachmentId | string | Да | ID вложения Confluence для удаления |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | Метка времени удаления |
attachmentId | string | ID удаленного вложения |
deleted | boolean | Статус удаления |
Получить список всех меток на странице Confluence.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для получения меток |
limit | number | Нет | Максимальное количество возвращаемых меток \(по умолчанию: 25, максимум: 250\) |
cursor | string | Нет | Курсор пагинации из предыдущего ответа |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | Метка времени получения |
labels | array | Массив меток на странице |
↳ id | string | Уникальный идентификатор метки |
↳ name | string | Имя метки |
↳ prefix | string | Префикс/тип метки \(например, global, my, team\) |
nextCursor | string | Курсор для получения следующей страницы результатов |
Добавить метку на страницу Confluence для организации и категоризации.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для добавления метки |
labelName | string | Да | Имя добавляемой метки |
prefix | string | Нет | Префикс метки: global \(по умолчанию\), my, team или system |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 метка времени операции |
pageId | string | ID страницы, на которую была добавлена метка |
labelName | string | Имя добавленной метки |
labelId | string | ID добавленной метки |
Удалить метку со страницы Confluence.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
pageId | string | Да | ID страницы Confluence для удаления метки |
labelName | string | Да | Имя удаляемой метки |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 метка времени операции |
pageId | string | ID страницы, с которой была удалена метка |
labelName | string | Имя удаленной метки |
deleted | boolean | Статус удаления |
Получить все страницы, к которым применена определенная метка.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
labelId | string | Да | ID метки для получения страниц |
limit | number | Нет | Максимальное количество возвращаемых страниц \(по умолчанию: 50, максимум: 250\) |
cursor | string | Нет | Курсор пагинации из предыдущего ответа |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 метка времени операции |
labelId | string | ID метки |
pages | array | Массив страниц с этой меткой |
↳ id | string | Уникальный идентификатор страницы |
↳ title | string | Заголовок страницы |
↳ status | string | Статус страницы \(например, current, archived, trashed, draft\) |
↳ spaceId | string | ID пространства, содержащего страницу |
↳ parentId | string | ID родительской страницы \(null, если верхнего уровня\) |
↳ authorId | string | Account ID автора страницы |
↳ createdAt | string | ISO 8601 метка времени создания страницы |
↳ version | object | Информация о версии страницы |
↳ number | number | Номер версии |
↳ message | string | Сообщение версии |
↳ minorEdit | boolean | Является ли это незначительным редактированием |
↳ authorId | string | Account ID автора версии |
↳ createdAt | string | ISO 8601 метка времени создания версии |
nextCursor | string | Курсор для получения следующей страницы результатов |
Получить список всех меток, связанных с пространством Confluence.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
spaceId | string | Да | ID пространства Confluence для получения меток |
limit | number | Нет | Максимальное количество возвращаемых меток \(по умолчанию: 25, максимум: 250\) |
cursor | string | Нет | Курсор пагинации из предыдущего ответа |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 метка времени операции |
spaceId | string | ID пространства |
labels | array | Массив меток в пространстве |
↳ id | string | Уникальный идентификатор метки |
↳ name | string | Имя метки |
↳ prefix | string | Префикс/тип метки \(например, global, my, team\) |
nextCursor | string | Курсор для получения следующей страницы результатов |
Получить детали о конкретном пространстве Confluence.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | Confluence space ID to retrieve |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type (global, personal) |
status | string | Space status (current, archived) |
url | string | URL to view the space in Confluence |
authorId | string | Account ID of the space creator |
createdAt | string | ISO 8601 timestamp when the space was created |
homepageId | string | ID of the space homepage |
description | object | Space description content |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
Создать новое пространство Confluence.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Ваш домен Confluence \(например, yourcompany.atlassian.net\) |
name | string | Да | Имя нового пространства |
key | string | Да | Уникальный ключ пространства \(заглавные буквы, без пробелов\) |
description | string | Нет | Описание нового пространства |
cloudId | string | Нет | Cloud ID экземпляра Confluence. Если не указан, будет получен с использованием домена. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Created space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type |
status | string | Space status |
url | string | URL to view the space |
homepageId | string | Homepage ID |
description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
Обновить Confluence space name или description.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | ID of the space to update |
name | string | Нет | New name for the space |
description | string | Нет | New description for the space |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Updated space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type |
status | string | Space status |
url | string | URL to view the space |
description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
Удалить Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | ID of the space to delete |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Deleted space ID |
deleted | boolean | Deletion status |
Список всех Confluence spaces accessible to the user.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
limit | number | Нет | Maximum number of spaces to return (default: 25, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaces | array | Массив Confluence spaces |
↳ id | string | Unique space identifier |
↳ key | string | Space key (short identifier used in URLs) |
↳ name | string | Space name |
↳ type | string | Space type (e.g., global, personal) |
↳ status | string | Space status (e.g., current, archived) |
↳ authorId | string | Account ID of the space creator |
↳ createdAt | string | ISO 8601 timestamp when the space was created |
↳ homepageId | string | ID of the space homepage |
↳ description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
nextCursor | string | Cursor for fetching the next page of results |
Список properties on a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | Space ID to list properties for |
limit | number | Нет | Maximum number of properties to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
properties | array | Массив space properties |
↳ id | string | Property ID |
↳ key | string | Property key |
↳ value | json | Property value |
spaceId | string | Space ID |
nextCursor | string | Cursor for fetching the next page of results |
Создать a property on a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | Space ID to create the property on |
key | string | Да | Property key/name |
value | json | Нет | Property value (JSON) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
propertyId | string | Created property ID |
key | string | Property key |
value | json | Property value |
spaceId | string | Space ID |
Удалить property from a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | Space ID the property belongs to |
propertyId | string | Да | Property ID to delete |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Space ID |
propertyId | string | Deleted property ID |
deleted | boolean | Deletion status |
Список permissions для a Confluence space.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
spaceId | string | Да | Space ID to list permissions for |
limit | number | Нет | Maximum number of permissions to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
permissions | array | Массив space permissions |
↳ id | string | Permission ID |
↳ principalType | string | Principal type (user, group, role) |
↳ principalId | string | Principal ID |
↳ operationKey | string | Operation key (read, create, delete, etc.) |
↳ operationTargetType | string | Target type (page, blogpost, space, etc.) |
↳ anonymousAccess | boolean | Whether anonymous access is allowed |
↳ unlicensedAccess | boolean | Whether unlicensed access is allowed |
spaceId | string | Space ID |
nextCursor | string | Cursor for fetching the next page of results |
Получить все descendants of a Confluence page recursively.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Да | Page ID to get descendants for |
limit | number | Нет | Maximum number of descendants to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
descendants | array | Массив descendant pages |
↳ id | string | Page ID |
↳ title | string | Page title |
↳ type | string | Content type (page, whiteboard, database, etc.) |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ parentId | string | Parent page ID |
↳ childPosition | number | Position among siblings |
↳ depth | number | Depth in the hierarchy |
pageId | string | Parent page ID |
nextCursor | string | Cursor for fetching the next page of results |
Список inline tasks from Confluence. Optionally filter by page, space, assignee, или status.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
pageId | string | Нет | Filter tasks by page ID |
spaceId | string | Нет | Filter tasks by space ID |
assignedTo | string | Нет | Filter tasks by assignee account ID |
status | string | Нет | Filter tasks by status (complete or incomplete) |
limit | number | Нет | Maximum number of tasks to return (default: 50, max: 250) |
cursor | string | Нет | Pagination cursor from previous response |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
tasks | array | Массив Confluence tasks |
↳ id | string | Task ID |
↳ localId | string | Local task ID |
↳ spaceId | string | Space ID |
↳ pageId | string | Page ID |
↳ blogPostId | string | Blog post ID |
↳ status | string | Task status (complete or incomplete) |
↳ body | string | Task body content in storage format |
↳ createdBy | string | Creator account ID |
↳ assignedTo | string | Assignee account ID |
↳ completedBy | string | Completer account ID |
↳ createdAt | string | Creation timestamp |
↳ updatedAt | string | Last update timestamp |
↳ dueAt | string | Due date |
↳ completedAt | string | Completion timestamp |
nextCursor | string | Cursor for fetching the next page of results |
Получить a specific Confluence inline task от ID.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
taskId | string | Да | The ID of the task to retrieve |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Task ID |
localId | string | Local task ID |
spaceId | string | Space ID |
pageId | string | Page ID |
blogPostId | string | Blog post ID |
status | string | Task status (complete or incomplete) |
body | string | Task body content in storage format |
createdBy | string | Creator account ID |
assignedTo | string | Assignee account ID |
completedBy | string | Completer account ID |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
dueAt | string | Due date |
completedAt | string | Completion timestamp |
Обновить the status of a Confluence inline task (complete или incomplete).
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
taskId | string | Да | The ID of the task to update |
status | string | Да | New status for the task (complete or incomplete) |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Task ID |
localId | string | Local task ID |
spaceId | string | Space ID |
pageId | string | Page ID |
blogPostId | string | Blog post ID |
status | string | Updated task status |
body | string | Task body content in storage format |
createdBy | string | Creator account ID |
assignedTo | string | Assignee account ID |
completedBy | string | Completer account ID |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
dueAt | string | Due date |
completedAt | string | Completion timestamp |
Обновитьn existing Confluence blog post title and/or content.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
blogPostId | string | Да | The ID of the blog post to update |
title | string | Нет | New title for the blog post |
content | string | Нет | New content for the blog post in storage format |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPostId | string | Updated blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
version | json | Version information |
url | string | URL to view the blog post |
Удалить Confluence blog post.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
blogPostId | string | Да | The ID of the blog post to delete |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPostId | string | Deleted blog post ID |
deleted | boolean | Deletion status |
Получить display name и profile info для a Confluence user by account ID.
| Параметр | Тип | Обязательный | Описание |
|---|
domain | string | Да | Your Confluence domain (e.g., yourcompany.atlassian.net) |
accountId | string | Да | The Atlassian account ID of the user to look up |
cloudId | string | Нет | Confluence Cloud ID для экземпляра. Если не предоставлен, it будет получен using the domain. |
| Параметр | Тип | Описание |
|---|
ts | string | ISO 8601 timestamp of the operation |
accountId | string | Atlassian account ID of the user |
displayName | string | Display name of the user |
email | string | Email address of the user |
accountType | string | Account type (e.g., atlassian, app, customer) |
profilePicture | string | Path to the user profile picture |
publicName | string | Public name of the user |
