Compartilhar via

Almanaque (Editor Independente) (versão prévia)

O Almanaque está construindo uma infraestrutura colaborativa para servir à criatividade humana. Usando a ferramenta wiki e fluxo de trabalho mais rápida, consolide seus documentos em uma bela e organizada fonte única de verdade.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor
Site https://almanac.io/
Política de privacidade https://almanac.io/privacy-policy
Categorias Colaboração; Conteúdo e arquivos

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
ID do workspace cadeia A ID do workspace para essa API. Verdade
Token de acesso (no formato 'Bearer yourAccessToken') secureString O Token de Acesso (no formato 'Bearer yourAccessToken') para essa API. Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar acesso a documentos

Adicionar acesso ao documento.
Adicionar propriedade de documento

Adicione uma propriedade personalizada a um documento.
Atualizar informações da pasta

Atualize uma metadada de pasta.
Atualizar informações do documento

Atualize as metaduções de um documento.
Atualizar o acesso ao documento

Atualize o acesso a um documento.
Criar item de manual

Adicione um item ao manual.
Criar propriedade de documento

Crie uma propriedade de documento no nível do workspace.
Criar uma pasta

Criar uma pasta.
Excluir item da pasta de trabalho

Excluir item do manual.
Excluir propriedade do documento

Remova uma propriedade personalizada de um documento.
Excluir propriedade personalizada do documento

Exclua uma propriedade personalizada de documento no nível do workspace.
Importar documento

Importe um documento de uma fonte externa.
Mover arquivos

Mover arquivos (documentos e/ou pastas) para uma pasta específica (no mesmo espaço de trabalho ou em outro espaço de trabalho).
Obter acessos a documentos

Listar acessos de documentos.
Obter documentos

Recuperar informações meta de todos os documentos no workspace.
Obter grupos

Recuperar grupos de usuários.
Obter importação

Recupere informações sobre uma importação existente.
Obter informações da pasta

Recupere uma lista de metadados de pasta.
Obter informações do documento

Recuperar informações meta de um documento.
Obter itens de manual

Recupere uma lista de itens de manual.
Obter manualmente

Recupere uma lista de pastas de trabalho.
Obter pastas

Recupere uma lista de todas as pastas.
Obter propriedades do documento

Listar propriedades personalizadas do documento no nível do workspace.
Obter propriedades do documento

Listar propriedades personalizadas do documento no nível do documento.
Obter usuários

Recupere uma lista de usuários.
Obter usuários em grupo

Recupere todos os usuários de um grupo de usuários.
Remover o acesso a documentos

Remova o acesso do documento.
Substituir informações da pasta

Substitua uma meta informativa de pasta.
Substituir informações do documento

Atualizar informações meta de um documento.
Substituir o acesso ao documento

Substitua o acesso a um documento.

Adicionar acesso a documentos

ID da operação:
PostDocsDocIdAccesses

Adicionar acesso ao documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Permissão
 access[permission] True string

A permissão.
Tipo de acessador
 access[accessor_type] True string

O tipo de acessador.
ID do acessador
 access[accessor_id] True integer

O identificador do acessador.
ID do documento
 doc_id True integer

O identificador do documento.

Retornos

Modelo de Acesso do Doc
DocAccess

Adicionar propriedade de documento

ID da operação:
PostDocsDocIdProperties

Adicione uma propriedade personalizada a um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Propriedade
 property_id True integer

O identificador de propriedade.
Value
 value string

O tipo de parâmetro depende do tipo de value propriedade: 'text', 'date', 'number', 'link' => String 'single_select' => { 'selected_item_id': Integer }, the PropertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, the selected PropertyValue#IDs 'checkbox' => { 'checked': Boolean } 'document' => { 'doc_id': Integer }, the Document#ID 'person' => { 'user_ids': Array[Integer] }, the User#IDs.
ID do documento
 doc_id True integer

O identificador do documento.

Retornos

Modelo de propriedade doc
DocProperty

Atualizar informações da pasta

ID da operação:
PatchFoldersId

Atualize uma metadada de pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da pasta
 folder[title] True string

O título da pasta.
ID
 id True integer

O identificador.

Retornos

Modelo de pasta
Folder

Atualizar informações do documento

ID da operação:
PatchDocsId

Atualize as metaduções de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
 doc[title] True string

O título do documento.
ID
 id True integer

O identificador.

Retornos

Modelo de documento
Doc

Atualizar o acesso ao documento

ID da operação:
PatchDocsDocIdAccessesId

Atualize o acesso a um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Permissão
 access[permission] True string

A permissão.
ID do documento
 doc_id True integer

O identificador do documento.
ID
 id True integer

O identificador.

Retornos

Modelo de Acesso do Doc
DocAccess

Criar item de manual

ID da operação:
PostHandbooksHandbookIdItems

Adicione um item ao manual.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de Item
 handbook_item[type] True string

O tipo de item do manual.
Posição do item
 handbook_item[position] integer

Acrescenta o item como última posição se não for fornecido.
ID do item pai
 handbook_item[parent_item_id] integer

ID do item pai para fins de aninhamento.
ID do documento
 handbook_item[doc_id] True integer

Necessário apenas para itens de documento.
Título do Item
 handbook_item[title] True string

Necessário apenas para itens de seção > de link.
Item URL
 handbook_item[url] True string

Necessário apenas para itens de link.
ID do manual
 handbook_id True integer

O identificador do manual.

Retornos

Modelo handbookItem
HandbookItem

Criar propriedade de documento

ID da operação:
PostProperties

Crie uma propriedade de documento no nível do workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome da propriedade
 property[name] True string

O nome da propriedade, que deve ser exclusivo por workspace.
Tipo de propriedade
 property[type] True string

O tipo de propriedade.
Padrão para artigos
 property[default_for_articles] boolean

Adicionar automaticamente essa propriedade a novos artigos? O padrão é false.
Formato de dados
 property[meta][date_format] string

Opcional para propriedades da data do tipo.
Formato de número
 property[meta][number_format] string

Opcional para propriedades do número de tipo.
Permitir menção a várias pessoas
 property[meta][allow_mentioning_multiple_people] boolean

Opcional para propriedades do tipo pessoa.
Notificar Pessoa
 property[meta][notify_person] boolean

Opcional para propriedades do tipo pessoa.
Valores da propriedade
 property[property_values][][value] True array

Os valores da propriedade.
Cor
 property[property_values][][meta][color] array

A cor.

Retornos

Modelo de propriedade
Property

Criar uma pasta

ID da operação:
PostFolders

Criar uma pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da pasta
 folder[title] True string

O título da pasta.
ID da pasta pai
 folder[parent_folder_id] integer

ID da pasta pai. Será criado na raiz do workspace se não for fornecido.

Retornos

Modelo de pasta
Folder

Excluir item da pasta de trabalho

ID da operação:
DeleteHandbooksHandbookIdItemsId

Excluir item do manual.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
 id True string

O identificador.
ID do manual
 handbook_id True integer

O identificador do manual.

Excluir propriedade do documento

ID da operação:
DeleteDocsDocIdPropertiesId

Remova uma propriedade personalizada de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True integer

O identificador do documento.
ID
 id True integer

O identificador.

Excluir propriedade personalizada do documento

ID da operação:
DeletePropertiesId

Exclua uma propriedade personalizada de documento no nível do workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
 id True integer

O identificador.

Importar documento

ID da operação:
PostImports

Importe um documento de uma fonte externa.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
 import[file] True file

O arquivo a ser importado.
Source
 import[source] True string

A origem do arquivo.

Retornos

Importar modelo
Import

Mover arquivos

ID da operação:
PostFilesMove

Mover arquivos (documentos e/ou pastas) para uma pasta específica (no mesmo espaço de trabalho ou em outro espaço de trabalho).

Parâmetros

Nome Chave Obrigatório Tipo Description
IDs de pasta
 folder_ids[] array

Os identificadores de pasta.
IDs de documento
 doc_ids[] array

Os identificadores do documento.
ID da pasta de destino
 destination_folder_id integer

O identificador da pasta de destino.
ID do workspace de destino
 destination_workspace_id integer

O identificador do workspace de destino.

Obter acessos a documentos

ID da operação:
GetDocsDocIdAccesses

Listar acessos de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID do documento
 doc_id True integer

O identificador do documento.

Retornos

response
array of DocAccess

Obter documentos

ID da operação:
GetDocs

Recuperar informações meta de todos os documentos no workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID da pasta
 folder_id string

Filtro opcional: mostre apenas os documentos que estão na raiz dessa pasta.

Retornos

response
array of Doc

Obter grupos

ID da operação:
GetGroups

Recuperar grupos de usuários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.

Retornos

response
array of Group

Obter importação

ID da operação:
GetImportsId

Recupere informações sobre uma importação existente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
 id True integer

O identificador.

Retornos

Importar modelo
Import

Obter informações da pasta

ID da operação:
GetFoldersId

Recupere uma lista de metadados de pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
 id True string

O identificador.

Retornos

Modelo de pasta
Folder

Obter informações do documento

ID da operação:
GetDocsId

Recuperar informações meta de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
 id True integer

O identificador.

Retornos

Modelo de documento
Doc

Obter itens de manual

ID da operação:
GetHandbooksHandbookIdItems

Recupere uma lista de itens de manual.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID do manual
 handbook_id True integer

O identificador do manual.

Retornos

response
array of HandbookItem

Obter manualmente

ID da operação:
GetHandbooks

Recupere uma lista de pastas de trabalho.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.

Retornos

response
array of Handbook

Obter pastas

ID da operação:
GetFolders

Recupere uma lista de todas as pastas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID da pasta pai
 parent_folder_id string

Filtro opcional: mostre apenas pastas com essa ID da pasta pai.

Retornos

response
array of Folder

Obter propriedades do documento

ID da operação:
GetProperties

Listar propriedades personalizadas do documento no nível do workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.

Retornos

response
array of Property

Obter propriedades do documento

ID da operação:
GetDocsDocIdProperties

Listar propriedades personalizadas do documento no nível do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID do documento
 doc_id True integer

O identificador do documento.

Retornos

response
array of DocProperty

Obter usuários

ID da operação:
GetUsers

Recupere uma lista de usuários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.

Retornos

response
array of User

Obter usuários em grupo

ID da operação:
GetGroupsGroupIdUsers

Recupere todos os usuários de um grupo de usuários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página
 page integer

Deslocamento de página a ser buscado.
Itens
 items integer

Número de itens a serem retornados por página.
ID do grupo
 group_id True integer

O identificador do grupo.

Retornos

response
array of User

Remover o acesso a documentos

ID da operação:
DeleteDocsDocIdAccessesId

Remova o acesso do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True integer

O identificador do documento.
ID
 id True integer

O identificador.

Substituir informações da pasta

ID da operação:
PutFoldersId

Substitua uma meta informativa de pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da pasta
 folder[title] True string

O título da pasta.
ID
 id True integer

O identificador.

Retornos

Modelo de pasta
Folder

Substituir informações do documento

ID da operação:
PutDocsId

Atualizar informações meta de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
 doc[title] True string

O título do documento.
ID
 id True integer

O identificador.

Retornos

Modelo de documento
Doc

Substituir o acesso ao documento

ID da operação:
PutDocsDocIdAccessesId

Substitua o acesso a um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Permissão
 access[permission] True string

A permissão.
ID do documento
 doc_id True integer

O identificador do documento.
ID
 id True integer

O identificador.

Retornos

Modelo de Acesso do Doc
DocAccess

Definições

Utilizador

Nome Caminho Tipo Description
ID
 id integer

O identificador
Primeiro Nome
 first_name string

O nome.
Apelido
 last_name string

O sobrenome.

Grupo

Nome Caminho Tipo Description
ID
 id integer

O identificador
Nome
 name string

O nome.
Description
 description string

A descrição.
Accessibility
 accessibility string

A acessibilidade.

Propriedade

Nome Caminho Tipo Description
ID
 id integer

O identificador
Nome
 name string

O nome.
Tipo
 type string

O tipo.
Padrão para artigos
 default_for_articles boolean

Se deve ser padrão para artigos.
meta
 meta PropertyMeta
property_values
 property_values array of PropertyValue

PropertyMeta

Nome Caminho Tipo Description
Formato de número
 number_format string

Retornado apenas e relevante para propriedades do número de tipo.
Formato de data
 date_format string

Retornado apenas e relevante para as propriedades da data do tipo
Permitir menção a várias pessoas
 allow_mentioning_multiple_people boolean

Retornado apenas e relevante para as propriedades da pessoa do tipo.
Notificar Pessoa
 notify_person boolean

Retornado apenas e relevante para as propriedades da pessoa do tipo.

PropertyValue

Nome Caminho Tipo Description
ID
 id integer

O identificador
ID da Propriedade
 property_id integer

O identificador de propriedade.
Value
 value string

O valor.
meta
 meta PropertyValueMeta

PropertyValueMeta

Nome Caminho Tipo Description
Cor
 color string

Retornado apenas e relevante para propriedades do tipo single_select e multi_select.

HandbookItem

Nome Caminho Tipo Description
ID
 id integer

O identificador
ID do manual
 handbook_id integer

O identificador do manual.
Tipo
 type string

O tipo.
Cargo
 position integer

A posição.
Title
 title string

Somente relevante para itens de seção > de link.
URL
 url string

Relevante apenas para itens de link.
ID do item pai
 parent_item_id integer

Não nulo se o item estiver aninhado.
ID do documento
 doc_id integer

Somente relevante para itens de documento.

Manual

Nome Caminho Tipo Description
ID
 id integer

O identificador
Nome
 name string

O nome.

Pasta

Nome Caminho Tipo Description
ID
 id integer

O identificador
Title
 title string

O título.
ID do workspace
 workspace_id integer

O identificador do workspace.
ID da pasta pai
 parent_folder_id integer

O identificador da pasta pai.

DocAccess

Nome Caminho Tipo Description
ID
 id integer

O identificador
ID do documento
 doc_id integer

O identificador do documento.
Permissão
 permission string

A permissão.
Tipo de acessador
 accessor_type string

O tipo de acessador.
ID do acessador
 accessor_id integer

O identificador do acessador.
Herdado
 inherited boolean

Se herdado.

DocProperty

Nome Caminho Tipo Description
ID
 id integer

O identificador
Modelo de propriedade
 property Property
Value
 value string

Tipo de depende do tipo de value propriedade: 'text', 'date', 'number', 'link' => String 'single_select' => { 'selected_item_id': Integer }, the PropertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, the selected PropertyValue#IDs 'checkbox' => { 'checked': Boolean } 'document' => { 'doc_id': Integer }, the Document#ID 'person' => { 'user_ids': Array[Integer] }, the User#IDs.

Doc

Nome Caminho Tipo Description
ID
 id integer

O identificador
Title
 title string

O título.
ID do workspace
 workspace_id integer

O identificador do workspace.
ID da pasta
 folder_id integer

O identificador da pasta.
ID do Proprietário
 owner_id integer

ID do usuário do proprietário do documento.
Criado em
 created_at string

ISO8601 datetime formatado.
Atualizado em
 updated_at string

ISO8601 datetime formatado.

Import

Nome Caminho Tipo Description
ID
 id integer

O identificador
status
 status string
Modelo de documento
 doc Doc