NetDocuments
O NetDocuments é um serviço de gerenciamento de conteúdo em nuvem para empresas de todos os tamanhos criarem, armazenarem, gerenciarem e compartilharem com segurança seu trabalho documental em qualquer lugar, a qualquer momento.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | 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 | Standard | 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 | Standard | 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 | |
|---|---|
| URL | https://support.netdocuments.com/hc/en-us |
| Metadados do conector | |
|---|---|
| Editora | NetDocuments Software, Inc. |
| Sítio Web | https://www.netdocuments.com/ |
| Política de privacidade | https://www.netdocuments.com/privacy-policy/ |
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 |
|---|---|---|---|
| Região | cadeia (de caracteres) | Região em que o seu documento líquido reside. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar ou remover grupo do gabinete |
Adicionar grupo ao gabinete e direitos de acesso padrão |
| Adicionar ou remover membro do grupo |
Adicionar ou remover membro do grupo |
| Adicionar ou remover usuário do repositório |
Adicionar ou remover usuário do repositório |
| Arquivar ou desarquivar documento para pasta |
Arquive um item em uma pasta ou desarquive um item de uma pasta. |
| Atualizar documento |
Atualizar o conteúdo de um documento |
| Atualizar um espaço de trabalho |
Atualizar um espaço de trabalho |
| Bloquear documento |
Bloquear documento |
| Bloquear versão do documento |
Bloquear versão do documento |
| Confira o documento |
Fazer check-out de um documento |
|
Criar Collab |
Crie um novo CollabSpace |
| Criar documento |
Criar um novo documento |
| Criar grupo de repositórios |
Criar um grupo de repositórios |
| Criar link seguro |
Gerar um link para um documento que pode ser acessado por qualquer pessoa |
| Criar ou atualizar uma entrada de tabela de pesquisa |
Criar ou atualizar uma entrada de tabela de pesquisa |
| Criar ou atualizar uma entrada de tabela de pesquisa filho |
Criar ou atualizar uma entrada de tabela de pesquisa filho |
| Criar pasta |
Criar uma nova pasta |
| Criar um grupo externo de gabinete |
Criar um grupo externo de gabinete |
| Criar uma nova versão de um documento |
Criar uma nova versão de um documento |
| Criar utilizador |
Criar um usuário em um repositório |
| Desbloquear documento |
Documento Unock |
| Documento de check-in |
Fazer check-in de um documento com check-out |
| Eliminar documento |
Eliminar um documento |
| Excluir grupo de repositórios |
Excluir um grupo de repositórios |
| Excluir pasta |
Excluir uma pasta |
| Excluir uma entrada de tabela de pesquisa |
Excluir uma entrada de tabela de pesquisa |
| Excluir uma entrada de tabela de pesquisa filho |
Excluir uma entrada de tabela de pesquisa filho |
| Histórico do documento |
Recuperar uma lista de ações executadas em um documento |
| Obter associação a um grupo |
Obter associação a um grupo |
| Obter atributos personalizados do gabinete |
Obter atributos personalizados do gabinete |
| Obter configurações de gabinete |
Obter configurações de gabinete |
| Obter conteúdo do contêiner |
Obter o conteúdo do contêiner selecionado |
| Obter conteúdo do documento |
Recuperar um documento |
| Obter direitos de acesso de grupos de gabinetes não ocultos |
Obter direitos de acesso de grupos de gabinetes não ocultos |
| Obter grupos de gabinetes |
Obter todos os grupos adicionados a um gabinete |
| Obter grupos de repositórios |
Obter grupos de repositórios |
| Obter informações atuais do usuário |
Obter informações sobre o usuário atual, ID não é necessário |
| Obter informações do gabinete |
Obter informações do gabinete |
| Obter informações do grupo |
Obter informações do grupo |
| Obter informações do repositório |
Obter informações do repositório |
| Obter informações do usuário |
Obter informações sobre um utilizador |
| Obter informações sobre o espaço de trabalho |
Obter informações sobre o espaço de trabalho |
| Obter itens de pasta |
Recuperar o conteúdo de uma pasta, incluindo documentos e subpastas |
| Obter lista de gabinetes de usuário |
Obter gabinetes de usuário |
| Obter log do repositório |
Obter log do repositório |
| Obter ou criar um espaço de trabalho (com atributos pai e filho) |
Obter ou criar um espaço de trabalho (com atributos pai e filho) |
| Obter ou criar um espaço de trabalho (com um único atributo) |
Obter ou criar um espaço de trabalho (com um único atributo) |
| Obter perfil do documento |
Obter informações sobre um documento |
| Obter uma entrada de tabela de pesquisa de criança |
Obter uma entrada de tabela de pesquisa de criança |
| Obter uma entrada de tabela de pesquisa ou procurar entradas de tabela filho |
Obter uma entrada de tabela de pesquisa ou procurar entradas de tabela filho |
| Obter usuários do repositório |
Obter usuários do repositório |
| Obter versões de documentos |
Obter versões de documentos |
| Pesquisar entradas de tabela de pesquisa |
Pesquisar entradas de tabela de pesquisa |
| Pesquisar um gabinete e modificar ACLs |
Pesquisar um gabinete e modificar ACLs |
| Pesquisar um ou mais gabinetes |
Pesquisar um ou mais gabinetes |
| Renomear documento |
Renomear um documento |
| Renomear pasta |
Renomear uma pasta |
| Seguir documento |
Receber alertas quando o documento for atualizado |
| Seguir pasta |
Receber alertas quando um novo conteúdo é adicionado a uma pasta |
Adicionar ou remover grupo do gabinete
Adicionar grupo ao gabinete e direitos de acesso padrão
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Adicionar ou remover grupo
|
action | True | string |
Adicionar ou remover grupo |
|
ID do grupo
|
id | True | string |
ID do grupo (começa com UG-). |
|
Ver direitos
|
view | True | boolean |
Direitos de visualização (V) - Apenas para adicionar. |
|
Editar direitos
|
edit | True | boolean |
Direitos de edição (E) - Apenas para adicionar. |
|
Direitos de partilha
|
share | True | boolean |
Direitos de partilha (S) - Apenas para adicionar. |
|
Administrar direitos
|
administer | True | boolean |
Administrar direitos (A) - Apenas para adicionar. |
|
Sem direitos de acesso
|
noAccess | True | boolean |
Sem direitos de acesso (N) - Apenas para adicionar. |
Adicionar ou remover membro do grupo
Adicionar ou remover membro do grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupID | True | string |
(Começa com UG-) |
|
Adicionar ou remover o usuário
|
action | True | string |
Adicionar ou remover o usuário |
|
ID de utilizador
|
member | True | string |
(Já deve ser membro do repositório.) |
Adicionar ou remover usuário do repositório
Adicionar ou remover usuário do repositório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
Adicionar ou remover usuário
|
action | True | string |
Adicionar ou remover usuário |
|
ID de utilizador
|
member | True | string |
ID de utilizador |
|
O usuário é externo
|
external | True | boolean |
O usuário é externo |
|
Excluir usuário (se federado)
|
deleteIfFederated | boolean |
(Aplicável apenas na remoção) |
Arquivar ou desarquivar documento para pasta
Arquive um item em uma pasta ou desarquive um item de uma pasta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
ID do documento
|
item | True | string |
ID do documento de 12 dígitos. |
|
Arquivar ou cancelar arquivo
|
action | True | string |
Arquivar ou cancelar arquivo |
Atualizar documento
Atualizar o conteúdo de um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Extensão do documento
|
extension | string |
Só é necessário se alterar a extensão do documento. Não inclua o período principal. |
|
|
Base64 codificado?
|
base64 | boolean |
Base64 codificado? |
|
|
Conteúdo atualizado do documento
|
body | True | byte |
O conteúdo do documento. |
Atualizar um espaço de trabalho
Atualizar um espaço de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspaceID | True | string |
ID do espaço de trabalho |
Bloquear documento
Bloquear documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
Documento iD |
|
Comment
|
comment | string |
Comment |
Bloquear versão do documento
Bloquear versão do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Versão do documento
|
version | True | integer |
Versão do documento |
|
Descrição da versão
|
description | string |
Descrição da versão |
Confira o documento
Fazer check-out de um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Comment
|
comment | string |
Comment |
|
|
Descarregar documento
|
download | boolean |
Retorna o conteúdo do documento. |
|
|
Versão para download
|
version | string |
Especifica qual conteúdo da versão deve ser baixado. O padrão é a versão oficial. |
|
|
Adicionar a recente
|
addToRecent | boolean |
Adicionar a recente |
Criar CollabSpace
Crie um novo CollabSpace
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspaceID | True | string |
ID do espaço de trabalho |
|
Nome CollabSpace
|
name | True | string |
Nome CollabSpace |
|
Description
|
description | string |
Description |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
Id | string | |
|
EnvUrl
|
EnvUrl | string |
Criar documento
Criar um novo documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Destino
|
destination | True | string |
O ID de 12 dígitos ou EnvID da pasta, filtro ou espaço de trabalho. |
|
Conteúdo do documento
|
file | True | file |
Coloque o nome do arquivo mais a extensão no campo do nome do arquivo que o acompanha. |
|
Adicionar a recente
|
addToRecent | boolean |
Adicionar a recente |
|
|
Perfil do documento
|
profile | string |
Definir o perfil do documento (formato JSON) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
extensão
|
extension | string | |
|
nome
|
name | string |
Criar grupo de repositórios
Criar um grupo de repositórios
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
Nome do grupo
|
name | True | string |
Nome do grupo |
|
External
|
external | True | boolean |
External |
|
Ocultar em listas
|
hidden | True | boolean |
Ocultar em listas |
|
Associação oculta
|
hideMembership | True | boolean |
Associação oculta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
externo
|
external | boolean | |
|
oculto
|
hidden | boolean | |
|
ocultarAdesão
|
hideMembership | boolean | |
|
id
|
id | string | |
|
nome
|
name | string |
Criar link seguro
Gerar um link para um documento que pode ser acessado por qualquer pessoa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Senha para o link seguro
|
password | string |
Dependendo da configuração do gabinete, a senha pode ser opcional ou obrigatória. |
|
|
Data de validade do link seguro.
|
expirationdate | string |
Formato de entrada: aaaa-MM-dd. |
|
|
Versão do documento
|
version | string |
Qual versão do documento compartilhar. Se estiver vazia, a versão oficial será partilhada. |
|
|
Descarregar documento
|
download | boolean |
Se verdadeiro, o documento pode ser baixado pelo destinatário. |
|
|
Notifique-me
|
notifyme | boolean |
Se verdadeiro, notifique o remetente quando o link seguro for acessado. |
|
|
Bloquear documento
|
lock | boolean |
Opcionalmente, bloqueie a versão selecionada do documento. Isso requer direitos de edição. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
vista
|
standardAttributes.view | string | |
|
descarregamento
|
standardAttributes.download | string |
Criar ou atualizar uma entrada de tabela de pesquisa
Criar ou atualizar uma entrada de tabela de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda) |
|
Key
|
parentID | True | string |
Key |
|
Description
|
description | string | ||
|
Tipo
|
defaulting | string | ||
|
Retenção de Litígios
|
hold | boolean | ||
|
Data de encerramento
|
closed | string |
Formato '/date(Número de millis a partir de 1 de janeiro de 1970+-UTC', como: '/date(1582261200000-0500)/' |
|
|
Permissões filtradas
|
filtered_permissions | True | boolean | |
|
Forçar permssions
|
force_permissions | True | boolean | |
|
View
|
view | True | boolean | |
|
Edit
|
edit | True | boolean | |
|
Share
|
share | True | boolean | |
|
Administer
|
administer | True | boolean | |
|
Sem acesso
|
noAccess | True | boolean | |
|
Gabinete padrão
|
cabDefault | True | boolean | |
|
Diretor
|
principal | True | string |
(ID de utilizador ou grupo) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Criar ou atualizar uma entrada de tabela de pesquisa filho
Criar ou atualizar uma entrada de tabela de pesquisa filho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave de criança
|
childID | True | string |
Chave de criança |
|
Description
|
description | string | ||
|
Tipo
|
defaulting | string | ||
|
Retenção de Litígios
|
hold | boolean | ||
|
Data de encerramento
|
closed | string |
Formato '/date(Número de millis a partir de 1 de janeiro de 1970+-UTC', como: '/date(1582261200000-0500)/' |
|
|
Permissões filtradas
|
filtered_permissions | True | boolean | |
|
Forçar permssions
|
force_permissions | True | boolean | |
|
View
|
view | True | boolean | |
|
Edit
|
edit | True | boolean | |
|
Share
|
share | True | boolean | |
|
Administer
|
administer | True | boolean | |
|
Sem acesso
|
noAccess | True | boolean | |
|
Gabinete padrão
|
cabDefault | True | boolean | |
|
Diretor
|
principal | True | string |
(ID de utilizador ou grupo) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Criar pasta
Criar uma nova pasta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da pasta
|
name | True | string |
Nome da pasta. |
|
ID do pai
|
parent | string |
ID de 12 dígitos ou EnvID do contêiner pai da nova pasta. |
|
|
ID do gabinete
|
cabinet | string |
(Começa com NG-) Pode ser omitido se uma pasta ou ID de espaço de trabalho for especificado no pai. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string | |
|
nome
|
standardAttributes.name | string |
Criar um grupo externo de gabinete
Criar um grupo externo de gabinete
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Nome do grupo
|
name | True | string |
Nome do grupo |
|
Opções de grupo
|
options | string |
Opções de grupo |
|
|
Acesso padrão ao gabinete
|
access | string |
Acesso padrão ao gabinete |
|
|
CollabSpace ID
|
collaborationSpaceId | string |
(Para tornar este um grupo externo do CollabSpace) |
|
|
Acesso ao CollabSpace
|
collaborationspaceaccess | string |
Acesso ao CollabSpace |
|
|
Valor do atributo do espaço de trabalho superior
|
topwsattributegroupkey | string |
(Para grupos externos de gabinete regulares; para associar o grupo a um valor de atributo de espaço de trabalho superior específico) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | integer | |
|
Id
|
Id | string | |
|
Nome
|
Name | string | |
|
Opções
|
Options | string | |
|
Access
|
Access | string |
Criar uma nova versão de um documento
Criar uma nova versão de um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Extensão do documento
|
extension | string |
Não inclua o período principal. |
|
|
Descrição da versão
|
version_description | string |
Descrição da versão |
|
|
Nome da nova versão
|
verName | string |
Nome da nova versão |
|
|
Fazer versão oficial
|
official | boolean |
A nova versão não será a versão oficial se este parâmetro não estiver definido. |
|
|
Adicionar a documentos recentes
|
addToRecent | boolean |
Adicionar a documentos recentes |
|
|
Número da versão de origem
|
srcVer | string |
Se estiver copiando o conteúdo de uma versão anterior, qual versão do documento copiar. |
|
|
Criar como uma subversão
|
allocatesubversion | boolean |
Crie como uma subversão em vez de como uma versão completa. |
|
|
Conteúdo do documento da nova versão
|
body | binary |
O conteúdo da nova versão, se não copiar outra versão ou a versão oficial. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
latestVersionNumber
|
latestVersionNumber | integer | |
|
newVer
|
newVer | integer | |
|
newVersionLabel
|
newVersionLabel | string | |
|
oficialVer
|
officialVer | integer | |
|
oficialVerName
|
officialVerName | string | |
|
versions
|
versions | integer |
Criar utilizador
Criar um usuário em um repositório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome de utilizador
|
username | True |
(O mesmo que o endereço de e-mail do usuário) |
|
|
Nome próprio
|
displayFirstName | True | string |
Nome próprio |
|
Nome do meio
|
displayMiddleName | string |
Nome do meio |
|
|
Apelido
|
displayLastName | True | string |
Apelido |
|
Endereço de e-mail
|
True |
Endereço de e-mail |
||
|
O usuário é externo
|
external | True | boolean |
(Aplicável apenas em adição) |
|
Enviar e-mail de boas-vindas
|
sendWelcome | True | boolean |
Enviar e-mail de boas-vindas |
|
ID do repositório
|
repository | True | string |
(Começa com CA-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
externo
|
external | boolean |
Desbloquear documento
Documento Unock
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento |
Documento de check-in
Fazer check-in de um documento com check-out
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Extensão do documento
|
extension | string |
Não inclua o período principal. |
|
|
Conteúdo do documento
|
file | file |
O documento em forma de várias partes. |
|
|
Adicionar a recente
|
addToRecent | boolean |
Adicione à lista de documentos recentes do usuário. |
Eliminar documento
Eliminar um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Excluir permanentemente
|
permanent | boolean |
Indica que o documento deve ser excluído permanentemente, em vez de movido para Itens Excluídos. |
Excluir grupo de repositórios
Excluir um grupo de repositórios
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do grupo
|
groupID | True | string |
(Começa com UG-) |
Excluir pasta
Excluir uma pasta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
Excluir permanentemente
|
permanent | boolean |
Indica que a pasta deve ser excluída permanentemente, em vez de movida para Itens Excluídos. O conteúdo da pasta, incluindo subpastas descendentes, não será excluído permanentemente. |
|
|
Excluir conteúdo da pasta
|
deleteContents | boolean |
Indica que os documentos na pasta excluída (e em qualquer subpasta descendente) também devem ser excluídos, em vez de simplesmente não serem arquivados. |
Excluir uma entrada de tabela de pesquisa
Excluir uma entrada de tabela de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda) |
|
Key
|
parentID | True | string |
Key |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Excluir uma entrada de tabela de pesquisa filho
Excluir uma entrada de tabela de pesquisa filho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave de criança
|
childID | True | string |
Chave de criança |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Histórico do documento
Recuperar uma lista de ações executadas em um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
Obter associação a um grupo
Obter associação a um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupID | True | string |
(Começa com UG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
nome de exibição
|
displayName | string | |
|
id
|
id | string |
Obter atributos personalizados do gabinete
Obter atributos personalizados do gabinete
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
items
|
object |
Obter configurações de gabinete
Obter configurações de gabinete
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Obter conteúdo do contêiner
Obter o conteúdo do contêiner selecionado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do contêiner
|
containerID | True | string |
ID do contêiner |
|
Informações a devolver
|
select | True | string |
(Revise a documentação para o formato de retorno) |
|
Número de resultados a retornar (o padrão é 50)
|
top | integer |
(Máximo 500 por página) |
|
|
Token usado para paginar resultados
|
skiptoken | string |
Token usado para paginar resultados |
|
|
Encomendar por
|
orderby | string |
(Formato: campo#|desc ou campo#|asc) |
Obter conteúdo do documento
Recuperar um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Base64 codificado?
|
base64 | boolean |
Base64 codificado? |
Obter direitos de acesso de grupos de gabinetes não ocultos
Obter direitos de acesso de grupos de gabinetes não ocultos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
administrar
|
administer | boolean | |
|
cabDefault
|
cabDefault | boolean | |
|
editar
|
edit | boolean | |
|
nome
|
name | string | |
|
noAcesso
|
noAccess | boolean | |
|
principal
|
principal | string | |
|
partilhar
|
share | boolean | |
|
vista
|
view | boolean |
Obter grupos de gabinetes
Obter todos os grupos adicionados a um gabinete
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
Id | string | |
|
Nome
|
Name | string | |
|
External
|
External | boolean | |
|
Escondido
|
Hidden | boolean |
Obter grupos de repositórios
Obter grupos de repositórios
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
Filter
|
$filter | string |
(Consulte a documentação para critérios de filtro) |
|
|
Número de resultados
|
$top | string |
(O padrão é 5.000. Máximo 10.000) |
|
|
Paging
|
paging | boolean |
(Retornar os resultados em páginas; o padrão é false) |
|
|
Token de paginação
|
$skiptoken | string |
(Para fins de paginação; devolvido por chamadas anteriores como 'próximo') |
|
|
Informações de retorno
|
returnInfo | string |
todos retornarão os nomes dos grupos. O padrão está em branco para retornar apenas IDs |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter informações atuais do usuário
Obter informações sobre o usuário atual, ID não é necessário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabGuid | string |
(Começa com NG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
organização
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primárioGabinete
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
externo
|
external | boolean |
Obter informações do gabinete
Obter informações do gabinete
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Obter informações do grupo
Obter informações do grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupID | True | string |
ID do grupo (começa com UG-). |
|
Membros do gabinete do grupo
|
cabMembership | boolean |
(Se definido como 'true' os gabinetes dos quais este grupo é membro e os direitos de acesso a documentos padrão para cada gabinete serão incluídos.) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
externo
|
external | boolean | |
|
oculto
|
hidden | boolean | |
|
ocultarAdesão
|
hideMembership | boolean | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
cabMembership
|
cabMembership | array of object | |
|
id
|
cabMembership.id | string | |
|
nome
|
cabMembership.name | string | |
|
Direitos
|
cabMembership.rights | string |
Obter informações do repositório
Obter informações do repositório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
Obter informações do usuário
Obter informações sobre um utilizador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
id | True | string |
O ID de usuário atribuído pelo NetDocuments. |
|
ID do gabinete
|
cabGuid | string |
(Começa com NG-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
organização
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primárioGabinete
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
externo
|
external | boolean |
Obter informações sobre o espaço de trabalho
Obter informações sobre o espaço de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspaceID | True | string |
ID do espaço de trabalho |
Obter itens de pasta
Recuperar o conteúdo de uma pasta, incluindo documentos e subpastas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
Atributos a serem retornados
|
$select | string |
Uma lista separada por vírgulas de valores de atributos. Consulte a documentação da API REST para obter mais detalhes. |
Obter lista de gabinetes de usuário
Obter gabinetes de usuário
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
isCollaborationSpacesEnabled
|
isCollaborationSpacesEnabled | string | |
|
nome
|
name | string | |
|
repositoryId
|
repositoryId | string | |
|
repositoryName
|
repositoryName | string | |
|
wsAttrNum
|
wsAttrNum | integer | |
|
wsOrgAttrNum
|
wsOrgAttrNum | integer |
Obter log do repositório
Obter log do repositório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
Data/hora de início
|
start | string |
(O padrão é 30 dias; formatar aaaa-MM-dd ou aaaa-MM-ddThh:mm:ssZ) |
|
|
Data/hora de fim
|
end | string |
(Mesmo formato do início; o padrão é hoje) |
|
|
Tipo de log
|
Logtype | True | string |
Tipo de log |
Obter ou criar um espaço de trabalho (com atributos pai e filho)
Obter ou criar um espaço de trabalho (com atributos pai e filho)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Valor pai
|
parentID | True | string |
O valor pai usado para definir espaços de trabalho no gabinete. |
|
Valor Criança
|
childID | True | string |
O valor filho usado para definir espaços de trabalho no gabinete. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Obter ou criar um espaço de trabalho (com um único atributo)
Obter ou criar um espaço de trabalho (com um único atributo)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Valor único
|
parentID | True | string |
O único valor usado para definir espaços de trabalho no gabinete. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Obter perfil do documento
Obter informações sobre um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
Obter uma entrada de tabela de pesquisa de criança
Obter uma entrada de tabela de pesquisa de criança
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave de criança
|
childID | True | string |
Chave de criança |
Obter uma entrada de tabela de pesquisa ou procurar entradas de tabela filho
Obter uma entrada de tabela de pesquisa ou procurar entradas de tabela filho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda. Para retornar um único valor, insira a ID do atributo pai ou, para procurar entradas filhas, insira a ID do atributo filho.) |
|
Key
|
parentID | True | string |
(Para retornar um único valor, digite a chave do atributo único ou, para procurar entradas filhas, insira a chave do pai.) |
|
Filtrar (apenas durante a pesquisa)
|
$filter | string |
(Consulte a documentação para obter os filtros disponíveis) |
|
|
Campos a recuperar
|
$select | string |
(Inclua uma lista separada por vírgulas de: 'chave', 'descrição', 'pai', 'manter', 'fechado', 'padrão', 'tipo', 'usuário' e/ou 'acesso') |
|
|
Número de registros correspondentes a serem ignorados
|
$skip | integer |
(Isso é usado ao recuperar vários blocos de resultados.) |
|
|
Número máximo de registos a devolver
|
$top | integer |
Número máximo de registos a devolver |
|
|
Ordene os resultados por
|
$orderby | string |
Ordene os resultados por |
Obter usuários do repositório
Obter usuários do repositório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
nome de exibição
|
displayName | string | |
|
e-mail
|
string | ||
|
externo
|
external | boolean | |
|
id
|
id | string | |
|
últimoLogin
|
lastLogin | string | |
|
registado
|
registered | string |
Obter versões de documentos
Obter versões de documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentID | True | string |
ID do documento de 12 dígitos. |
Pesquisar entradas de tabela de pesquisa
Pesquisar entradas de tabela de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda) |
|
Filter
|
$filter | string |
(Consulte a documentação para obter os filtros disponíveis) |
|
|
Campos a recuperar
|
$select | string |
(Inclua uma lista separada por vírgulas de: 'chave', 'descrição', 'pai', 'manter', 'fechado', 'padrão', 'tipo', 'usuário' e/ou 'acesso') |
|
|
Número de registros correspondentes a serem ignorados
|
$skip | integer |
(Isso é usado ao recuperar vários blocos de resultados.) |
|
|
Número máximo de registos a devolver
|
$top | integer |
Número máximo de registos a devolver |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
linhas
|
rows | array of object | |
|
inadimplência
|
rows.defaulting | string | |
|
descrição
|
rows.description | string | |
|
segurar
|
rows.hold | boolean | |
|
chave
|
rows.key | string | |
|
fechado
|
rows.closed | string | |
|
acesso
|
rows.access | string |
Pesquisar um gabinete e modificar ACLs
Pesquisar um gabinete e modificar ACLs
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Query
|
q | True | string |
(Revise a documentação para o formato de consulta) |
|
Modificar o modo ACL
|
mode | True | string |
Modificar o modo ACL |
|
Nova ACL
|
newAcl | True | string |
(Revise a documentação para o formato json adequado) |
|
Endereço de e-mail
|
(Em vez disso, envie a notificação para este endereço) |
|||
|
Enviar e-mails de conclusão
|
completionEmail | string |
(true = enviar sempre (padrão), false = não enviar, falhar = enviar somente em falha) |
Pesquisar um ou mais gabinetes
Pesquisar um ou mais gabinetes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Armários
|
cabinets | True | string |
(delimitado por vírgula) |
|
Query
|
q | True | string |
(Revise a documentação para o formato de consulta) |
|
Informações a devolver
|
select | True | string |
(Revise a documentação para o formato de retorno) |
|
Encomendar por
|
orderby | string |
(Formato: campo#|desc ou campo#|asc) |
|
|
Número de resultados a retornar (o padrão é 50)
|
top | integer |
(Máximo 500 por página) |
|
|
Número de resultados a ignorar
|
skip | integer |
Número de resultados a ignorar |
|
|
Token usado para paginar resultados
|
skiptoken | string |
Token usado para paginar resultados |
Renomear documento
Renomear um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Novo nome
|
name | True | string |
Renomear pasta
Renomear uma pasta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
Novo nome
|
name | True | string |
Seguir documento
Receber alertas quando o documento for atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Destinatários
|
recipients | True | string |
Um ou mais endereços de e-mail válidos separados por ponto-e-vírgula. Duplicatas ignoradas. |
|
Enviar
|
send | string |
Que categoria de utilizadores deve receber o alerta. |
Seguir pasta
Receber alertas quando um novo conteúdo é adicionado a uma pasta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
Destinatários
|
recipients | True | string |
Um ou mais endereços de e-mail válidos separados por ponto-e-vírgula. Duplicatas ignoradas. |
|
Enviar
|
send | string |
Que categoria de utilizadores deve receber o alerta. |
Acionadores
| Gabinete de pesquisa |
Pesquisar o gabinete especificado |
Gabinete de pesquisa
Pesquisar o gabinete especificado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabId | True | string |
(Começa com NG-) |
|
Critérios de pesquisa
|
q | True | string |
Use o mesmo formato e operadores que na interface web NetDocuments. |
|
Encomendar por
|
$orderby | string |
Encomendar por |
|
|
Número máximo de resultados
|
$top | string |
Um número inteiro entre 1 e 500. O padrão é 100. |
|
|
Atributos a serem retornados
|
$select | string |
Uma lista separada por vírgulas de valores de atributos. Consulte a documentação da API REST para obter mais detalhes. |