Partilhar via

Almanac (Editora Independente) (Pré-visualização)

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://almanac.io/
Política de privacidade https://almanac.io/privacy-policy
Categorias Colaboração; Conteúdo e Ficheiros

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 espaço de trabalho cadeia (de caracteres) O ID do espaço de trabalho para esta API. Verdade
Token de acesso (no formato 'Bearer yourAccessToken') securestring O Token de Acesso (no formato 'Bearer yourAccessToken') para esta API. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar acesso ao documento

Adicionar acesso ao documento.
Adicionar propriedade do documento

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

Atualize uma meta informação de pasta.
Atualizar informações do documento

Atualizar meta-informações de um documento.
Atualizar o acesso aos documentos

Atualizar o acesso a um documento.
Criar item de manual

Adicione um item ao manual.
Criar pasta

Crie uma pasta.
Criar propriedade do documento

Crie uma propriedade de documento no nível do espaço de trabalho.
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 do documento no nível do espaço de trabalho.
Importar documento

Importe um documento de uma fonte externa.
Mover ficheiros

Mova ficheiros (documentos e/ou pastas) para uma pasta específica (na mesma área de trabalho ou em espaços de trabalho diferentes).
Obter acessos a documentos

Listar acessos a documentos.
Obter documentos

Recupere meta-informações de todos os documentos no espaço de trabalho.
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 meta informações da pasta.
Obter informações do documento

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

Recupere uma lista de itens do manual.
Obter manuais

Recupere uma lista de manuais do espaço de trabalho.
Obter pastas

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

Liste as propriedades personalizadas do documento no nível do espaço de trabalho.
Obter propriedades do documento

Liste as propriedades personalizadas do documento no nível do documento.
Obter utilizadores

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

Recupere todos os usuários de um grupo de usuários.
Remover o acesso ao documento

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

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

Atualize as meta-informações de um documento.
Substituir o acesso a documentos

Substitua o acesso a um documento.

Adicionar acesso ao documento

ID da Operação:
PostDocsDocIdAccesses

Adicionar acesso ao documento.

Parâmetros

Name Chave Necessá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 de acesso.
ID do documento
 doc_id True integer

O identificador do documento.

Devoluções

Modelo de Acesso ao Documento
DocAccess

Adicionar propriedade do documento

ID da Operação:
PostDocsDocIdProperties

Adicione uma propriedade personalizada a um documento.

Parâmetros

Name Chave Necessário Tipo Description
ID da Propriedade
 property_id True integer

O identificador de propriedade.
Valor
 value string

O tipo de param 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.

Devoluções

Modelo de propriedade Doc
DocProperty

Atualizar informações da pasta

ID da Operação:
PatchFoldersId

Atualize uma meta informação de pasta.

Parâmetros

Name Chave Necessário Tipo Description
Título da pasta
 folder[title] True string

O título da pasta.
ID
 id True integer

O identificador.

Devoluções

Modelo de pasta
Folder

Atualizar informações do documento

ID da Operação:
PatchDocsId

Atualizar meta-informações de um documento.

Parâmetros

Name Chave Necessário Tipo Description
Title
 doc[title] True string

O título do documento.
ID
 id True integer

O identificador.

Devoluções

Modelo Doc
Doc

Atualizar o acesso aos documentos

ID da Operação:
PatchDocsDocIdAccessesId

Atualizar o acesso a um documento.

Parâmetros

Name Chave Necessá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.

Devoluções

Modelo de Acesso ao Documento
DocAccess

Criar item de manual

ID da Operação:
PostHandbooksHandbookIdItems

Adicione um item ao manual.

Parâmetros

Name Chave Necessá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 item como última posição, se não 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

Apenas necessário para itens de documentos.
Título do item
 handbook_item[title] True string

Apenas necessário para itens de link de seção & .
Item URL
 handbook_item[url] True string

Apenas necessário para itens de link.
ID do Manual
 handbook_id True integer

O identificador do manual.

Devoluções

Modelo HandbookItem
HandbookItem

Criar pasta

ID da Operação:
PostFolders

Crie uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Título da pasta
 folder[title] True string

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

ID da pasta pai. Será criado na raiz do espaço de trabalho se não for fornecido.

Devoluções

Modelo de pasta
Folder

Criar propriedade do documento

ID da Operação:
PostProperties

Crie uma propriedade de documento no nível do espaço de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
Nome da propriedade
 property[name] True string

O nome da propriedade, que deve ser exclusivo por espaço de trabalho.
Tipo de Propriedade
 property[type] True string

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

Adicionar automaticamente esta propriedade a novos artigos? O valor padrão é falso.
Formato dos dados
 property[meta][date_format] string

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

Opcional para propriedades do tipo número.
Permitir a menção de 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 de propriedade
 property[property_values][][value] True array

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

A cor.

Devoluções

Modelo de Propriedade
Property

Excluir item da pasta de trabalho

ID da Operação:
DeleteHandbooksHandbookIdItemsId

Excluir item do manual.

Parâmetros

Name Chave Necessá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

Name Chave Necessá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 do documento no nível do espaço de trabalho.

Parâmetros

Name Chave Necessá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

Name Chave Necessário Tipo Description
Ficheiro
 import[file] True file

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

A origem do arquivo.

Devoluções

Modelo de importação
Import

Mover ficheiros

ID da Operação:
PostFilesMove

Mova ficheiros (documentos e/ou pastas) para uma pasta específica (na mesma área de trabalho ou em espaços de trabalho diferentes).

Parâmetros

Name Chave Necessário Tipo Description
IDs de pasta
 folder_ids[] array

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

Os identificadores doc.
ID da pasta de destino
 destination_folder_id integer

O identificador da pasta de destino.
ID do espaço de trabalho de destino
 destination_workspace_id integer

O identificador do espaço de trabalho de destino.

Obter acessos a documentos

ID da Operação:
GetDocsDocIdAccesses

Listar acessos a documentos.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

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

O identificador do documento.

Devoluções

response
array of DocAccess

Obter documentos

ID da Operação:
GetDocs

Recupere meta-informações de todos os documentos no espaço de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

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

Filtro opcional: mostra apenas os documentos que estão na raiz desta pasta.

Devoluções

response
array of Doc

Obter grupos

ID da Operação:
GetGroups

Recuperar grupos de usuários.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.

Devoluções

response
array of Group

Obter importação

ID da Operação:
GetImportsId

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

Parâmetros

Name Chave Necessário Tipo Description
ID
 id True integer

O identificador.

Devoluções

Modelo de importação
Import

Obter informações da pasta

ID da Operação:
GetFoldersId

Recupere uma lista de meta informações da pasta.

Parâmetros

Name Chave Necessário Tipo Description
ID
 id True string

O identificador.

Devoluções

Modelo de pasta
Folder

Obter informações do documento

ID da Operação:
GetDocsId

Recuperar meta-informações de um documento.

Parâmetros

Name Chave Necessário Tipo Description
ID
 id True integer

O identificador.

Devoluções

Modelo Doc
Doc

Obter itens do manual

ID da Operação:
GetHandbooksHandbookIdItems

Recupere uma lista de itens do manual.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.
ID do Manual
 handbook_id True integer

O identificador do manual.

Devoluções

response
array of HandbookItem

Obter manuais

ID da Operação:
GetHandbooks

Recupere uma lista de manuais do espaço de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.

Devoluções

response
array of Handbook

Obter pastas

ID da Operação:
GetFolders

Recupere uma lista de todas as pastas.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.
ID da pasta principal
 parent_folder_id string

Filtro opcional: mostre apenas pastas com este ID de pasta pai.

Devoluções

response
array of Folder

Obter propriedades do documento

ID da Operação:
GetProperties

Liste as propriedades personalizadas do documento no nível do espaço de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.

Devoluções

response
array of Property

Obter propriedades do documento

ID da Operação:
GetDocsDocIdProperties

Liste as propriedades personalizadas do documento no nível do documento.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

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

O identificador do documento.

Devoluções

response
array of DocProperty

Obter utilizadores

ID da Operação:
GetUsers

Recupere uma lista de usuários.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

Número de itens a devolver por página.

Devoluções

response
array of User

Obter utilizadores em grupo

ID da Operação:
GetGroupsGroupIdUsers

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

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

Deslocamento de página para buscar.
Itens
 items integer

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

O identificador de grupo.

Devoluções

response
array of User

Remover o acesso ao documento

ID da Operação:
DeleteDocsDocIdAccessesId

Remova o acesso do documento.

Parâmetros

Name Chave Necessá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 informação de pasta.

Parâmetros

Name Chave Necessário Tipo Description
Título da pasta
 folder[title] True string

O título da pasta.
ID
 id True integer

O identificador.

Devoluções

Modelo de pasta
Folder

Substituir informações do documento

ID da Operação:
PutDocsId

Atualize as meta-informações de um documento.

Parâmetros

Name Chave Necessário Tipo Description
Title
 doc[title] True string

O título do documento.
ID
 id True integer

O identificador.

Devoluções

Modelo Doc
Doc

Substituir o acesso a documentos

ID da Operação:
PutDocsDocIdAccessesId

Substitua o acesso a um documento.

Parâmetros

Name Chave Necessá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.

Devoluções

Modelo de Acesso ao Documento
DocAccess

Definições

User

Name Caminho Tipo Description
ID
 id integer

O identificador
Nome Próprio
 first_name string

O primeiro nome.
Apelido
 last_name string

O sobrenome.

Grupo

Name 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

Name 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 o padrão para artigos.
meta
 meta PropertyMeta
property_values
 property_values array of PropertyValue

PropriedadeMeta

Name Caminho Tipo Description
Formato de Número
 number_format string

Somente retornou & relevantes para propriedades de número de tipo.
Formato de data
 date_format string

Somente retornados & relevantes para propriedades do tipo data
Permitir a menção de várias pessoas
 allow_mentioning_multiple_people boolean

Apenas retornou & relevantes para propriedades do tipo pessoa.
Notificar Pessoa
 notify_person boolean

Apenas retornou & relevantes para propriedades do tipo pessoa.

PropertyValue

Name Caminho Tipo Description
ID
 id integer

O identificador
ID da Propriedade
 property_id integer

O identificador de propriedade.
Valor
 value string

O valor.
meta
 meta PropertyValueMeta

PropertyValueMeta

Name Caminho Tipo Description
Cor
 color string

Somente retornou & relevantes para propriedades do tipo single_select e multi_select.

HandbookItem

Name Caminho Tipo Description
ID
 id integer

O identificador
ID do Manual
 handbook_id integer

O identificador do manual.
Tipo
 type string

O tipo.
Position
 position integer

A posição.
Title
 title string

Apenas relevante para itens de link de seção & .
URL
 url string

Apenas relevante 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

Relevante apenas para itens de documentos.

Manual

Name Caminho Tipo Description
ID
 id integer

O identificador
Nome
 name string

O nome.

Folder

Name Caminho Tipo Description
ID
 id integer

O identificador
Title
 title string

O título.
ID do espaço de trabalho
 workspace_id integer

O identificador do espaço de trabalho.
ID da pasta principal
 parent_folder_id integer

O identificador da pasta pai.

DocAccess

Name 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 de acesso.
Herdado
 inherited boolean

Se herdado.

DocProperty

Name Caminho Tipo Description
ID
 id integer

O identificador
Modelo de Propriedade
 property Property
Valor
 value string

O 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.

Doutoramento

Name Caminho Tipo Description
ID
 id integer

O identificador
Title
 title string

O título.
ID do espaço de trabalho
 workspace_id integer

O identificador do espaço de trabalho.
ID da pasta
 folder_id integer

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

ID de utilizador do proprietário do documento.
Criado em
 created_at string

ISO8601 formatado datetime.
Atualizado em
 updated_at string

ISO8601 formatado datetime.

Import

Name Caminho Tipo Description
ID
 id integer

O identificador
estado
 status string
Modelo Doc
 doc Doc