Функции
- Поиск страницы по указанному ключу пространства и заголовку страницы
- Обновление содержимого найденной страницы
- Удаление страницы
- Создание новой страницы
Источники и ссылки
- Примеры запросов к API REST Confluence: https://developer.atlassian.com/server/confluence/confluence-rest-api-examples
- Статья про интеграцию с JIRA через API REST //infostart.ru/1c/tools/821900/
Как настроить
На вкладке Настройки вам нужно заполнить:
- Имя сервера - имя сервера или ip адрес, где расположен Confluence
- Порт - порт, где расположен Confluence. Если не заполнен, то будет использоваться порт по умолчанию.
- SSL - нужно установить флаг, если используется защищенное соединение (https, а не http)
- Логин - ваш логин в Confluence
- Пароль - ваш пароль в Confluence
- Базовый url - общая часть ссылки, по который доступны методы API. По умолчанию "rest/api"
Далее, можно нажать кнопку "Тест". Если все правильно настроено, то при нажатии будет выведено сообщение "Успешно".
Как использовать
1. Поиск и обновление данных статьи
Для поиска статьи нужно указать имя пространства. Посмотреть его можно так:
Далее, указать заголовок статьи в пространстве. Теперь можно нажать кнопку "Найти страницу". В случае успешного поиска данные формы будут заполнены.
Вы можете отредактировать тело (в формате HTML документа) и нажать на кнопку "Обновить страницу". Данные страницы в Confluence будут обновлены.
2. Создание статьи
Для создания статьи вам нужно заполнить поля:
- Ключ пространства - смотрите выше, как его узнать
- ИД Родитель - ид страницы, куда вы хотите добавить новую страницу (см. ниже)
- Заголовок - заголовок для новой страницы
- Тип страницы - по умолчанию значение page. С другими типами страниц не тестировалось
- Тело (содержимое) - данные в формате HTML для размещения на новой странице
Например, чтобы узнать ИД страницы, куда вы хотите добавить новую страницу, можно посмотреть в строку URL запроса этой страницы. Там в параметре pageid будет нужный вам ИД.
3. Удаление статьи
Для удаления статьи достаточно указать ИД удаляемой страницы. Как ее узнать см. выше.
Что с этим делать?
Данная возможность позволяет автоматизировать процессы создания документации. Вы можете автоматически формировать нужные вам разделы документации и держать их в актуальном состоянии. Мы использовали данную возможность, чтобы автоматически формировать разделы документации в Confluence по объектам метаданных и о том, в рамках каких задач эти объекты были изменены, кем изменены и в какое время.
