NetDocuments
O NetDocuments é um serviço de gerenciamento de conteúdo de nuvem para empresas de todos os tamanhos criarem, armazenarem, gerenciarem e compartilharem com segurança o trabalho do documento em qualquer lugar, a qualquer momento.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | 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 | Standard | 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 | Standard | 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 | |
|---|---|
| URL | https://support.netdocuments.com/hc/en-us |
| Metadados do conector | |
|---|---|
| Publicador | NetDocuments Software, Inc. |
| Site | https://www.netdocuments.com/ |
| Política de privacidade | https://www.netdocuments.com/privacy-policy/ |
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 |
|---|---|---|---|
| Região | cadeia | Região em que seu documento líquido reside. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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 usuário ou remover usuário do repositório |
Adicionar usuário ou remover usuário do repositório |
| Arquivar ou desfilar documento na pasta |
Arquive um item em uma pasta ou desfile um item de uma pasta. |
| Atualizar documento |
Atualizar o conteúdo de um documento |
| Atualizar um workspace |
Atualizar um workspace |
| Bloquear documento |
Bloquear documento |
| Bloquear versão do documento |
Bloquear versão do documento |
|
Criar Collab |
Criar um novo CollabSpace |
| Criar documento |
Criar um novo documento |
| Criar grupo de repositórios |
Criar um grupo de repositórios |
| Criar link protegido |
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 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 uma pasta |
Criar uma nova pasta |
| Criar usuário |
Criar um usuário em um repositório |
| Desbloquear documento |
Desembalar documento |
| Documento de check-out |
Fazer check-out de um documento |
| Excluir documento |
Excluir 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 |
| Fazer check-in do documento |
Fazer check-in de um documento de check-out |
| Histórico de documentos |
Recuperar uma lista de ações executadas em um documento |
| Obter associação de grupo |
Obter associação de 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 gabinete não ocultos |
Obter direitos de acesso de grupos de gabinete não ocultos |
| Obter grupos de gabinete |
Obter todos os grupos adicionados a um gabinete |
| Obter grupos de repositório |
Obter grupos de repositório |
| Obter informações atuais do usuário |
Obtenha informações sobre o usuário atual, a ID não é necessária |
| 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 usuário |
| Obter informações do workspace |
Obter informações do workspace |
| Obter itens de pasta |
Recuperar o conteúdo de uma pasta, incluindo documentos e subpastas |
| Obter lista de gabinetes de usuário |
Obter armários de usuário |
| Obter log do repositório |
Obter log do repositório |
| Obter o perfil do documento |
Obter informações sobre um documento |
| Obter ou criar um workspace (com atributos pai e filho) |
Obter ou criar um workspace (com atributos pai e filho) |
| Obter ou criar um workspace (com um único atributo) |
Obter ou criar um workspace (com um único atributo) |
| Obter uma entrada de tabela de pesquisa filho |
Obter uma entrada de tabela de pesquisa filho |
| Obter uma entrada de tabela de pesquisa ou pesquisar entradas de tabela filho |
Obter uma entrada de tabela de pesquisa ou pesquisar entradas de tabela filho |
| Obter usuários do repositório |
Obter usuários do repositório |
| Obter versões do documento |
Obter versões do documento |
| 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 o documento |
Receber alertas quando o documento for atualizado |
| Seguir pasta |
Receber alertas quando o novo conteúdo for adicionado a uma pasta |
Adicionar ou remover grupo do gabinete
Adicionar grupo ao gabinete e direitos de acesso padrão
Parâmetros
| Nome | Chave | Obrigató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-). |
|
Direitos de exibição
|
view | True | boolean |
Direitos de exibição (V) – somente para adição. |
|
Editar direitos
|
edit | True | boolean |
Editar direitos (E) – somente para adição. |
|
Compartilhar direitos
|
share | True | boolean |
Direitos de compartilhamento (S) – somente para adição. |
|
Administrar direitos
|
administer | True | boolean |
Administrar direitos (A) – somente para adição. |
|
Sem direitos de acesso
|
noAccess | True | boolean |
Nenhum direito de acesso (N) – somente para adição. |
Adicionar ou remover membro do grupo
Adicionar ou remover membro do grupo
Parâmetros
| Nome | Chave | Obrigató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 do Usuário
|
member | True | string |
(Já deve ser membro do repositório).) |
Adicionar usuário ou remover usuário do repositório
Adicionar usuário ou remover usuário do repositório
Parâmetros
| Nome | Chave | Obrigató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 do Usuário
|
member | True | string |
ID do Usuário |
|
O usuário é externo
|
external | True | boolean |
O usuário é externo |
|
Excluir usuário (se federado)
|
deleteIfFederated | boolean |
(Aplicável somente na remoção) |
Arquivar ou desfilar documento na pasta
Arquive um item em uma pasta ou desfile um item de uma pasta.
Parâmetros
| Nome | Chave | Obrigató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. |
|
Arquivo ou unfile
|
action | True | string |
Arquivo ou unfile |
Atualizar documento
Atualizar o conteúdo de um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Extensão do documento
|
extension | string |
Necessário somente se alterar a extensão do documento. Não inclua o período à esquerda. |
|
|
Codificado em Base64?
|
base64 | boolean |
Codificado em Base64? |
|
|
Conteúdo do documento atualizado
|
body | True | byte |
O conteúdo do documento. |
Atualizar um workspace
Atualizar um workspace
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspaceID | True | string |
ID do workspace |
Bloquear documento
Bloquear documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento |
|
Comment
|
comment | string |
Comment |
Bloquear versão do documento
Bloquear versão do documento
Parâmetros
| Nome | Chave | Obrigató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 |
Criar CollabSpace
Criar um novo CollabSpace
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspaceID | True | string |
ID do workspace |
|
Nome do CollabSpace
|
name | True | string |
Nome do CollabSpace |
|
Description
|
description | string |
Description |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
Id | string | |
|
EnvUrl
|
EnvUrl | string |
Criar documento
Criar um novo documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Destino
|
destination | True | string |
A ID de 12 dígitos ou EnvID da pasta, filtro ou workspace. |
|
Conteúdo do documento
|
file | True | file |
Coloque o nome do arquivo mais a extensão no campo nome de arquivo que o acompanha. |
|
Adicionar ao recente
|
addToRecent | boolean |
Adicionar ao recente |
|
|
Perfil do documento
|
profile | string |
Definir o perfil do documento (formato JSON) |
Retornos
| Nome | 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
externo
|
external | boolean | |
|
oculto
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
id
|
id | string | |
|
nome
|
name | string |
Criar link protegido
Gerar um link para um documento que pode ser acessado por qualquer pessoa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Senha para o link protegido
|
password | string |
Dependendo da configuração do gabinete, a senha pode ser opcional ou obrigatória. |
|
|
Data de validade do link protegido.
|
expirationdate | string |
Formato de entrada: yyyy-MM-dd. |
|
|
Versão do documento
|
version | string |
Qual versão do documento compartilhar. Se estiver vazia, a versão oficial será compartilhada. |
|
|
Baixar documento
|
download | boolean |
Se for true, o documento poderá ser baixado pelo destinatário. |
|
|
Notificar-me
|
notifyme | boolean |
Se for true, notifique o remetente quando o link protegido for acessado. |
|
|
Bloquear documento
|
lock | boolean |
Opcionalmente, bloqueie a versão selecionada do documento. Isso requer direitos de edição. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
exibição
|
standardAttributes.view | string | |
|
baixar
|
standardAttributes.download | string |
Criar ou atualizar uma entrada de tabela de pesquisa
Criar ou atualizar uma entrada de tabela de pesquisa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
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ígio
|
hold | boolean | ||
|
Data de Encerramento
|
closed | string |
Formatar '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/' |
|
|
Permissões filtradas
|
filtered_permissions | True | boolean | |
|
Forçar permsões
|
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 | |
|
Padrão do gabinete
|
cabDefault | True | boolean | |
|
Entidade de segurança
|
principal | True | string |
(ID de usuário ou grupo) |
Retornos
| Nome | 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave filho
|
childID | True | string |
Chave filho |
|
Description
|
description | string | ||
|
Tipo
|
defaulting | string | ||
|
Retenção de litígio
|
hold | boolean | ||
|
Data de Encerramento
|
closed | string |
Formatar '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/' |
|
|
Permissões filtradas
|
filtered_permissions | True | boolean | |
|
Forçar permsões
|
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 | |
|
Padrão do gabinete
|
cabDefault | True | boolean | |
|
Entidade de segurança
|
principal | True | string |
(ID de usuário ou grupo) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Criar um grupo externo de gabinete
Criar um grupo externo de gabinete
Parâmetros
| Nome | Chave | Obrigató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 do gabinete
|
access | string |
Acesso padrão do gabinete |
|
|
CollabSpace ID
|
collaborationSpaceId | string |
(Para tornar este um grupo collabSpace-external) |
|
|
Acesso ao CollabSpace
|
collaborationspaceaccess | string |
Acesso ao CollabSpace |
|
|
Valor principal do atributo do workspace
|
topwsattributegroupkey | string |
(Para grupos externos de gabinete regulares; para associar o grupo a um valor de atributo de workspace superior específico) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | integer | |
|
ID
|
Id | string | |
|
Nome
|
Name | string | |
|
Opções
|
Options | string | |
|
Acesso
|
Access | string |
Criar uma nova versão de um documento
Criar uma nova versão de um documento
Parâmetros
| Nome | Chave | Obrigató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 à esquerda. |
|
|
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 |
|
|
Tornar a versão oficial
|
official | boolean |
A nova versão não será a versão oficial se esse 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 será copiada. |
|
|
Criar como uma subversão
|
allocatesubversion | boolean |
Crie como uma subversão em vez de como uma versão completa. |
|
|
Conteúdo do novo documento de versão
|
body | binary |
O conteúdo da nova versão, se não estiver copiando outra versão ou a versão oficial. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
latestVersionNumber
|
latestVersionNumber | integer | |
|
newVer
|
newVer | integer | |
|
newVersionLabel
|
newVersionLabel | string | |
|
officialVer
|
officialVer | integer | |
|
officialVerName
|
officialVerName | string | |
|
versões
|
versions | integer |
Criar uma pasta
Criar uma nova pasta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da pasta
|
name | True | string |
Nome da pasta. |
|
ID Principal
|
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 ID de pasta ou workspace for especificada no pai. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string | |
|
nome
|
standardAttributes.name | string |
Criar usuário
Criar um usuário em um repositório
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome de usuário
|
username | True |
(O mesmo que o endereço de email do usuário) |
|
|
Nome
|
displayFirstName | True | string |
Nome |
|
Nome do meio
|
displayMiddleName | string |
Nome do meio |
|
|
Sobrenome
|
displayLastName | True | string |
Sobrenome |
|
Endereço de email
|
True |
Endereço de email |
||
|
O usuário é externo
|
external | True | boolean |
(Aplicável somente ao adicionar) |
|
Enviar email de boas-vindas
|
sendWelcome | True | boolean |
Enviar email de boas-vindas |
|
ID do repositório
|
repository | True | string |
(Começa com CA-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
email
|
|||
|
id
|
id | string | |
|
externo
|
external | boolean |
Desbloquear documento
Desembalar documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento |
Documento de check-out
Fazer check-out de um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Comment
|
comment | string |
Comment |
|
|
Baixar documento
|
download | boolean |
Retorna o conteúdo do documento. |
|
|
Versão a ser baixada
|
version | string |
Especifica qual conteúdo da versão deve ser baixado. O padrão é a versão oficial. |
|
|
Adicionar ao recente
|
addToRecent | boolean |
Adicionar ao recente |
Excluir documento
Excluir um documento
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do grupo
|
groupID | True | string |
(Começa com UG-) |
Excluir pasta
Excluir uma pasta
Parâmetros
| Nome | Chave | Obrigató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 filtrados. |
Excluir uma entrada de tabela de pesquisa
Excluir uma entrada de tabela de pesquisa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda) |
|
Key
|
parentID | True | string |
Key |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Excluir uma entrada de tabela de pesquisa filho
Excluir uma entrada de tabela de pesquisa filho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave filho
|
childID | True | string |
Chave filho |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
count
|
count | integer |
Fazer check-in do documento
Fazer check-in de um documento de check-out
Parâmetros
| Nome | Chave | Obrigató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 à esquerda. |
|
|
Conteúdo do Documento
|
file | file |
O documento no formulário de várias partes. |
|
|
Adicionar ao recente
|
addToRecent | boolean |
Adicione à lista de documentos recentes do usuário. |
Histórico de documentos
Recuperar uma lista de ações executadas em um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
Obter associação de grupo
Obter associação de grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupID | True | string |
(Começa com UG-) |
Retornos
| Nome | 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
items
|
object |
Obter configurações de gabinete
Obter configurações de gabinete
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contêiner
|
containerID | True | string |
ID do contêiner |
|
Informações a serem retornadas
|
select | True | string |
(Examine a documentação do formato de retorno) |
|
Número de resultados a serem retornados (padrões para 50)
|
top | integer |
(Máximo de 500 por página) |
|
|
Token usado para paginar resultados
|
skiptoken | string |
Token usado para paginar resultados |
|
|
Ordem por
|
orderby | string |
(Formatar: field#|desc ou field#|asc) |
Obter conteúdo do documento
Recuperar um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
|
Codificado em Base64?
|
base64 | boolean |
Codificado em Base64? |
Obter direitos de acesso de grupos de gabinete não ocultos
Obter direitos de acesso de grupos de gabinete não ocultos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
administrar
|
administer | boolean | |
|
cabDefault
|
cabDefault | boolean | |
|
edição
|
edit | boolean | |
|
nome
|
name | string | |
|
noAccess
|
noAccess | boolean | |
|
entidade de segurança
|
principal | string | |
|
compartilhamento
|
share | boolean | |
|
exibição
|
view | boolean |
Obter grupos de gabinete
Obter todos os grupos adicionados a um gabinete
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
Id | string | |
|
Nome
|
Name | string | |
|
External
|
External | boolean | |
|
Oculto
|
Hidden | boolean |
Obter grupos de repositório
Obter grupos de repositório
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
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 de 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; retornado por chamadas anteriores como 'next') |
|
|
Informações de retorno
|
returnInfo | string |
todos retornarão nomes de grupo. O padrão está em branco para retornar apenas IDs |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter informações atuais do usuário
Obtenha informações sobre o usuário atual, a ID não é necessária
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabGuid | string |
(Começa com NG-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
email
|
|||
|
id
|
id | string | |
|
organização
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
externo
|
external | boolean |
Obter informações do gabinete
Obter informações do gabinete
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupID | True | string |
ID do grupo (começa com UG-). |
|
Associação ao gabinete do grupo
|
cabMembership | boolean |
(Se definido como 'true' os gabinetes dos quais esses grupos são membros e os direitos de acesso de documento padrão para cada gabinete serão incluídos.) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
externo
|
external | boolean | |
|
oculto
|
hidden | boolean | |
|
hideMembership
|
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
| Nome | Chave | Obrigató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 usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
id | True | string |
A ID de usuário atribuída pelo NetDocuments. |
|
ID do gabinete
|
cabGuid | string |
(Começa com NG-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
email
|
|||
|
id
|
id | string | |
|
organização
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
externo
|
external | boolean |
Obter informações do workspace
Obter informações do workspace
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspaceID | True | string |
ID do workspace |
Obter itens de pasta
Recuperar o conteúdo de uma pasta, incluindo documentos e subpastas
Parâmetros
| Nome | Chave | Obrigató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 atributo. Consulte a documentação da API REST para obter mais detalhes. |
Obter lista de gabinetes de usuário
Obter armários de usuário
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
isCollaborationSpacesEnabled
|
isCollaborationSpacesEnabled | string | |
|
nome
|
name | string | |
|
repositórioId
|
repositoryId | string | |
|
repositórioName
|
repositoryName | string | |
|
wsAttrNum
|
wsAttrNum | integer | |
|
wsOrgAttrNum
|
wsOrgAttrNum | integer |
Obter log do repositório
Obter log do repositório
Parâmetros
| Nome | Chave | Obrigató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 yyyy-MM-dd ou yyyy-MM-ddThh:mm:ssZ) |
|
|
Data/hora de término
|
end | string |
(Mesmo formato do início; o padrão é atual) |
|
|
Tipo de log
|
Logtype | True | string |
Tipo de log |
Obter o perfil do documento
Obter informações sobre um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento de 12 dígitos. |
Obter ou criar um workspace (com atributos pai e filho)
Obter ou criar um workspace (com atributos pai e filho)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Valor pai
|
parentID | True | string |
O valor pai usado para definir workspaces no gabinete. |
|
Valor filho
|
childID | True | string |
O valor filho usado para definir workspaces no gabinete. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Obter ou criar um workspace (com um único atributo)
Obter ou criar um workspace (com um único atributo)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Valor exclusivo
|
parentID | True | string |
O único valor usado para definir workspaces no gabinete. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Obter uma entrada de tabela de pesquisa filho
Obter uma entrada de tabela de pesquisa filho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo filho
|
childAttributeID | True | string |
(Remova o '10' à esquerda) |
|
Chave pai
|
parentID | True | string |
Chave pai |
|
Chave filho
|
childID | True | string |
Chave filho |
Obter uma entrada de tabela de pesquisa ou pesquisar entradas de tabela filho
Obter uma entrada de tabela de pesquisa ou pesquisar entradas de tabela filho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda. Para retornar um único valor, insira a ID do atributo pai ou, para pesquisar entradas filho, insira a ID do atributo filho.) |
|
Key
|
parentID | True | string |
(Para retornar um único valor, insira a chave do atributo único ou, para pesquisar entradas filho, insira a chave do pai.) |
|
Filtrar (somente ao pesquisar)
|
$filter | string |
(Consulte a documentação dos filtros disponíveis) |
|
|
Campos a serem recuperados
|
$select | string |
(Inclua lista separada por vírgulas de: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user' e/ou 'access') |
|
|
Número de registros correspondentes para ignorar
|
$skip | integer |
(Isso é usado ao recuperar vários blocos de resultados.) |
|
|
Número máximo de registros a serem retornados
|
$top | integer |
Número máximo de registros a serem retornados |
|
|
Resultados da ordem por
|
$orderby | string |
Resultados da ordem por |
Obter usuários do repositório
Obter usuários do repositório
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Começa com CA-) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
nome de exibição
|
displayName | string | |
|
email
|
string | ||
|
externo
|
external | boolean | |
|
id
|
id | string | |
|
lastLogin
|
lastLogin | string | |
|
registado
|
registered | string |
Obter versões do documento
Obter versões do documento
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do repositório
|
repositoryID | True | string |
(Ele começa com AC-) |
|
ID do atributo
|
attributeID | True | string |
(Remova o '10' à esquerda) |
|
Filter
|
$filter | string |
(Consulte a documentação dos filtros disponíveis) |
|
|
Campos a serem recuperados
|
$select | string |
(Inclua lista separada por vírgulas de: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user' e/ou 'access') |
|
|
Número de registros correspondentes para ignorar
|
$skip | integer |
(Isso é usado ao recuperar vários blocos de resultados.) |
|
|
Número máximo de registros a serem retornados
|
$top | integer |
Número máximo de registros a serem retornados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Linhas
|
rows | array of object | |
|
Falta
|
rows.defaulting | string | |
|
descrição
|
rows.description | string | |
|
suspensão
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do gabinete
|
cabinetID | True | string |
(Começa com NG-) |
|
Query
|
q | True | string |
(Examine a documentação do formato de consulta) |
|
Modificar o modo ACL
|
mode | True | string |
Modificar o modo ACL |
|
Nova ACL
|
newAcl | True | string |
(Examine a documentação do formato json adequado) |
|
Endereço de email
|
(Enviar notificação para esse endereço em vez disso) |
|||
|
Enviar emails de conclusão
|
completionEmail | string |
(true = send always (default), false = don't send, fail = send only on fail) |
Pesquisar um ou mais gabinetes
Pesquisar um ou mais gabinetes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Armários
|
cabinets | True | string |
(delimitado por vírgula) |
|
Query
|
q | True | string |
(Examine a documentação do formato de consulta) |
|
Informações a serem retornadas
|
select | True | string |
(Examine a documentação do formato de retorno) |
|
Ordem por
|
orderby | string |
(Formatar: field#|desc ou field#|asc) |
|
|
Número de resultados a serem retornados (padrões para 50)
|
top | integer |
(Máximo de 500 por página) |
|
|
Número de resultados a serem ignoradas
|
skip | integer |
Número de resultados a serem ignoradas |
|
|
Token usado para paginar resultados
|
skiptoken | string |
Token usado para paginar resultados |
Renomear documento
Renomear um documento
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
id | True | string |
ID da pasta de 12 dígitos. |
|
Novo nome
|
name | True | string |
Seguir o documento
Receber alertas quando o documento for atualizado
Parâmetros
| Nome | Chave | Obrigató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 email válidos separados por ponto e vírgula. Duplicatas ignoradas. |
|
Send
|
send | string |
Qual categoria de usuários deve receber o alerta. |
Seguir pasta
Receber alertas quando o novo conteúdo for adicionado a uma pasta
Parâmetros
| Nome | Chave | Obrigató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 email válidos separados por ponto e vírgula. Duplicatas ignoradas. |
|
Send
|
send | string |
Qual categoria de usuários deve receber o alerta. |
Gatilhos
| Gabinete de pesquisa |
Pesquisar o gabinete especificado |
Gabinete de pesquisa
Pesquisar o gabinete especificado
Parâmetros
| Nome | Chave | Obrigató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 da Web netDocuments. |
|
Ordem por
|
$orderby | string |
Ordem por |
|
|
Número máximo de resultados
|
$top | string |
Um inteiro entre 1 e 500. O padrão é 100. |
|
|
Atributos a serem retornados
|
$select | string |
Uma lista separada por vírgulas de valores de atributo. Consulte a documentação da API REST para obter mais detalhes. |