Almanac (независимый издатель) (предварительная версия)

Almanac создает совместную инфраструктуру для обслуживания человеческого творчества. Используя самый быстрый инструмент вики-сайта и рабочего процесса, консолидируйте документы в красивый, упорядоченный один источник истины.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Веб-сайт	https://almanac.io/
Политика конфиденциальности	https://almanac.io/privacy-policy
Категории	Сотрудничество; Содержимое и файлы

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Идентификатор рабочей области	струна	Идентификатор рабочей области для этого API.	True
Маркер доступа (в форме носителя yourAccessToken)	securestring	Маркер доступа (в форме Bearer yourAccessToken) для этого API.	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Добавление доступа к документам	Добавление доступа к документу.
Добавление свойства документа	Добавьте настраиваемое свойство в документ.
Замена доступа к документам	Замените доступ к документу.
Замена сведений о документе	Обновите метаданные документа.
Замена сведений о папке	Замените метаданные папки.
Импорт документа	Импорт документа из внешнего источника.
Обновление доступа к документам	Обновление доступа к документу.
Обновление сведений о документе	Обновите метаданные документа.
Обновление сведений о папке	Обновите метаданные папки.
Перемещение файлов	Переместите файлы (документы и/или папки) в определенную папку (в той же или другой рабочей области).
Получение групп	Получение групп пользователей.
Получение документов	Получение метаданных всех документов в рабочей области.
Получение доступа к документам	Вывод списка доступа к документам.
Получение импорта	Получение сведений о существующем импорте.
Получение папок	Получение списка всех папок.
Получение пользователей	Получение списка пользователей.
Получение пользователей в группе	Получение всех пользователей группы пользователей.
Получение сведений о документе	Получение метаданных документа.
Получение сведений о папке	Получение списка метаданных папок.
Получение свойств документа	Вывод списка настраиваемых свойств документа на уровне рабочей области.
Получение свойств документа	Вывод списка настраиваемых свойств документа на уровне документа.
Получение справочников	Получите список руководств по рабочей области.
Получение элементов руководства	Получение списка элементов руководства.
Создание свойства документа	Создайте свойство документа на уровне рабочей области.
Создание элемента руководства	Добавьте элемент в справочник.
Создать папку	Создайте папку.
Удаление доступа к документам	Удаление доступа из документа.
Удаление пользовательского свойства документа	Удаление настраиваемого свойства документа на уровне рабочей области.
Удаление свойства документа	Удалите пользовательское свойство из документа.
Удаление элемента книги	Удалите элемент из справочника.

Добавление доступа к документам

Идентификатор операции:

PostDocsDocIdAccesses

Добавление доступа к документу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Разрешение	access[permission]	True	string	Разрешение.
Тип метода доступа	access[accessor_type]	True	string	Тип метода доступа.
Идентификатор метода доступа	access[accessor_id]	True	integer	Идентификатор метода доступа.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.

Возвращаемое значение

Модель доступа к документам

DocAccess

Добавление свойства документа

Идентификатор операции:

PostDocsDocIdProperties

Добавьте настраиваемое свойство в документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор свойства	property_id	True	integer	Идентификатор свойства.
Ценность	value		string	value Тип param зависит от типа свойства: "text", "date", "number", "link" = String "single_select" =>> { "selected_item_id": Integer }, PropertyValue#ID "multi_select" => { "selected_item_ids": Array[Integer] }, выбранный идентификатор PropertyValue#IDs " checkbox" => { "checked": Boolean } "document" => { "doc_id": integer }, the Document#ID "person" => { "user_ids": Array[Integer] }, user#IDs.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.

Возвращаемое значение

Модель свойств Doc

DocProperty

Замена доступа к документам

Идентификатор операции:

PutDocsDocIdAccessesId

Замените доступ к документу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Разрешение	access[permission]	True	string	Разрешение.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель доступа к документам

DocAccess

Замена сведений о документе

Идентификатор операции:

PutDocsId

Обновите метаданные документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Название	doc[title]	True	string	Заголовок документа.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель документа

Doc

Замена сведений о папке

Идентификатор операции:

PutFoldersId

Замените метаданные папки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок папки	folder[title]	True	string	Заголовок папки.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель папок

Folder

Импорт документа

Идентификатор операции:

PostImports

Импорт документа из внешнего источника.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Файл	import[file]	True	file	Импортируемый файл.
Исходный материал	import[source]	True	string	Источник файла.

Возвращаемое значение

Импорт модели

Import

Обновление доступа к документам

Идентификатор операции:

PatchDocsDocIdAccessesId

Обновление доступа к документу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Разрешение	access[permission]	True	string	Разрешение.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель доступа к документам

DocAccess

Обновление сведений о документе

Идентификатор операции:

PatchDocsId

Обновите метаданные документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Название	doc[title]	True	string	Заголовок документа.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель документа

Doc

Обновление сведений о папке

Идентификатор операции:

PatchFoldersId

Обновите метаданные папки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок папки	folder[title]	True	string	Заголовок папки.
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель папок

Folder

Перемещение файлов

Идентификатор операции:

PostFilesMove

Переместите файлы (документы и/или папки) в определенную папку (в той же или другой рабочей области).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы папок	folder_ids[]		array	Идентификаторы папок.
Идентификаторы документов	doc_ids[]		array	Идентификаторы документов.
Идентификатор целевой папки	destination_folder_id		integer	Идентификатор целевой папки.
Идентификатор целевой рабочей области	destination_workspace_id		integer	Идентификатор целевой рабочей области.

Получение групп

Идентификатор операции:

GetGroups

Получение групп пользователей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.

Возвращаемое значение

response

array of Group

Получение документов

Идентификатор операции:

GetDocs

Получение метаданных всех документов в рабочей области.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор папки	folder_id		string	Необязательный фильтр: отображаются только документы, которые находятся в корне этой папки.

Возвращаемое значение

response

array of Doc

Получение доступа к документам

Идентификатор операции:

GetDocsDocIdAccesses

Вывод списка доступа к документам.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.

Возвращаемое значение

response

array of DocAccess

Получение импорта

Идентификатор операции:

GetImportsId

Получение сведений о существующем импорте.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Импорт модели

Import

Получение папок

Идентификатор операции:

GetFolders

Получение списка всех папок.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор родительской папки	parent_folder_id		string	Необязательный фильтр: отображаются только папки с идентификатором родительской папки.

Возвращаемое значение

response

array of Folder

Получение пользователей

Идентификатор операции:

GetUsers

Получение списка пользователей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.

Возвращаемое значение

response

array of User

Получение пользователей в группе

Идентификатор операции:

GetGroupsGroupIdUsers

Получение всех пользователей группы пользователей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор группы	group_id	True	integer	Идентификатор группы.

Возвращаемое значение

response

array of User

Получение сведений о документе

Идентификатор операции:

GetDocsId

Получение метаданных документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Модель документа

Doc

Получение сведений о папке

Идентификатор операции:

GetFoldersId

Получение списка метаданных папок.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Возвращаемое значение

Модель папок

Folder

Получение свойств документа

Идентификатор операции:

GetProperties

Вывод списка настраиваемых свойств документа на уровне рабочей области.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.

Возвращаемое значение

response

array of Property

Получение свойств документа

Идентификатор операции:

GetDocsDocIdProperties

Вывод списка настраиваемых свойств документа на уровне документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор документа	doc_id	True	integer	Идентификатор документа.

Возвращаемое значение

response

array of DocProperty

Получение справочников

Идентификатор операции:

GetHandbooks

Получите список руководств по рабочей области.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.

Возвращаемое значение

response

array of Handbook

Получение элементов руководства

Идентификатор операции:

GetHandbooksHandbookIdItems

Получение списка элементов руководства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Смещение страницы для получения.
Товары	items		integer	Количество элементов, возвращаемых на страницу.
Идентификатор справочника	handbook_id	True	integer	Идентификатор справочника.

Возвращаемое значение

response

array of HandbookItem

Создание свойства документа

Идентификатор операции:

PostProperties

Создайте свойство документа на уровне рабочей области.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Название свойства	property[name]	True	string	Имя свойства, которое должно быть уникальным для каждой рабочей области.
Тип свойства	property[type]	True	string	Тип свойства.
По умолчанию для статей	property[default_for_articles]		boolean	Автоматическое добавление этого свойства в новые статьи? По умолчанию — false.
Формат данных	property[meta][date_format]		string	Необязательно для свойств даты типа.
Форматирование чисел	property[meta][number_format]		string	Необязательно для свойств числа типов.
Разрешить упоминание нескольких пользователей	property[meta][allow_mentioning_multiple_people]		boolean	Необязательно для свойств типа person.
Уведомление пользователя	property[meta][notify_person]		boolean	Необязательно для свойств типа person.
Значения свойств	property[property_values][][value]	True	array	Значения свойств.
Цвет	property[property_values][][meta][color]		array	Цвет.

Возвращаемое значение

Модель свойств

Property

Создание элемента руководства

Идентификатор операции:

PostHandbooksHandbookIdItems

Добавьте элемент в справочник.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип элемента	handbook_item[type]	True	string	Тип элемента руководства.
Позиция элемента	handbook_item[position]		integer	Добавляет элемент в качестве последней позиции, если он не указан.
Идентификатор родительского элемента	handbook_item[parent_item_id]		integer	Идентификатор родительского элемента для вложенных целей.
Идентификатор документа	handbook_item[doc_id]	True	integer	Требуется только для элементов документации.
Название элемента	handbook_item[title]	True	string	Требуется только для элементов раздела и ссылок.
URL-адрес элемента	handbook_item[url]	True	string	Требуется только для элементов ссылки.
Идентификатор справочника	handbook_id	True	integer	Идентификатор справочника.

Возвращаемое значение

Модель СправочникаItem

HandbookItem

Создать папку

Идентификатор операции:

PostFolders

Создайте папку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок папки	folder[title]	True	string	Заголовок папки.
Идентификатор родительской папки	folder[parent_folder_id]		integer	Идентификатор родительской папки. Будет создан в корневом каталоге рабочей области, если он не указан.

Возвращаемое значение

Модель папок

Folder

Удаление доступа к документам

Идентификатор операции:

DeleteDocsDocIdAccessesId

Удаление доступа из документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	integer	Идентификатор документа.
Идентификатор	id	True	integer	Идентификатор.

Удаление пользовательского свойства документа

Идентификатор операции:

DeletePropertiesId

Удаление настраиваемого свойства документа на уровне рабочей области.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Удаление свойства документа

Идентификатор операции:

DeleteDocsDocIdPropertiesId

Удалите пользовательское свойство из документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	integer	Идентификатор документа.
Идентификатор	id	True	integer	Идентификатор.

Удаление элемента книги

Идентификатор операции:

DeleteHandbooksHandbookIdItemsId

Удалите элемент из справочника.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Идентификатор справочника	handbook_id	True	integer	Идентификатор справочника.

Определения

User

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Имя (Первое имя)	first_name	string	Первое имя.
Фамилия	last_name	string	Фамилия.

Группа

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Имя	name	string	Имя.
Description	description	string	Описание.
Доступность	accessibility	string	Специальные возможности.

Недвижимость

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Имя	name	string	Имя.
Тип	type	string	Тип.
По умолчанию для статей	default_for_articles	boolean	Значение по умолчанию для статей.
мета	meta	PropertyMeta
property_values	property_values	array of PropertyValue

PropertyMeta

Имя	Путь	Тип	Описание
Форматирование чисел	number_format	string	Возвращается и относится только к свойствам числа типов.
Формат даты	date_format	string	Возвращается и относится только к свойствам даты типа
Разрешить упоминание нескольких пользователей	allow_mentioning_multiple_people	boolean	Возвращается только для свойств типа person.
Уведомление пользователя	notify_person	boolean	Возвращается только для свойств типа person.

PropertyValue

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Идентификатор свойства	property_id	integer	Идентификатор свойства.
Ценность	value	string	Значение.
мета	meta	PropertyValueMeta

PropertyValueMeta

Имя	Путь	Тип	Описание
Цвет	color	string	Возвращается только для свойств типа single_select и multi_select.

СправочникItem

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Идентификатор справочника	handbook_id	integer	Идентификатор справочника.
Тип	type	string	Тип.
Position	position	integer	Позиция.
Название	title	string	Применимо только для элементов раздела и ссылок.
URL	url	string	Применимо только для элементов ссылки.
Идентификатор родительского элемента	parent_item_id	integer	Значение NULL, если элемент вложен.
Идентификатор документа	doc_id	integer	Относится только к элементам документации.

Справочник

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Имя	name	string	Имя.

Folder

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Название	title	string	Заголовок.
Идентификатор рабочей области	workspace_id	integer	Идентификатор рабочей области.
Идентификатор родительской папки	parent_folder_id	integer	Идентификатор родительской папки.

DocAccess

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Идентификатор документа	doc_id	integer	Идентификатор документа.
Разрешение	permission	string	Разрешение.
Тип метода доступа	accessor_type	string	Тип метода доступа.
Идентификатор метода доступа	accessor_id	integer	Идентификатор метода доступа.
Наследование	inherited	boolean	Наследуется ли он.

DocProperty

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Модель свойств	property	Property
Ценность	value	string	value Тип зависит от типа свойства: "text", "date", "number", "link" = String "single_select" =>> { "selected_item_id": целое число }, PropertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, выбранный идентификатор PropertyValue#IDs => { 'checked': Boolean } 'document' => { 'doc_id': integer }, document#ID => { 'user_ids': Array[Integer] }, идентификаторы пользователя.

Доктор

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
Название	title	string	Заголовок.
Идентификатор рабочей области	workspace_id	integer	Идентификатор рабочей области.
Идентификатор папки	folder_id	integer	Идентификатор папки.
Идентификатор ответственного	owner_id	integer	Идентификатор пользователя владельца документа.
Создано в	created_at	string	ISO8601 форматированных дат и времени.
Обновлено в	updated_at	string	ISO8601 форматированных дат и времени.

Import

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Идентификатор
статус	status	string
Модель документа	doc	Doc