Partilhar via

DocuWare

Aceda a funcionalidades comuns do DocuWare a partir dos seus fluxos.

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 DocuWare GmbH
URL https://support.docuware.com
Email support@docuware.com
Metadados do conector
Editora DocuWare
Sítio Web https://start.docuware.com
Política de privacidade https://start.docuware.com/data-privacy
Categorias Conteúdos e Ficheiros; Produtividade

O DocuWare fornece uma poderosa e extensa API REST. Com o Power Automate Connector do DocuWare, os usuários agora podem aproveitar muitos dos recursos mais comuns da API REST do DocuWare no Power Automate. Isso permite ao usuário maior flexibilidade para criar fluxos que atendem plenamente às suas necessidades de negócios, graças à integração perfeita com o DocuWare.

Pré-requisitos

Você precisará do seguinte para prosseguir:

  • Uma assinatura do DocuWare Cloud
  • Uma conta do Microsoft Power Apps ou Power Automate

Como obter credenciais

Criar uma nova chave de API é fácil e pode ser feito a partir do DocuWare.

Siga estas etapas para criar uma nova chave de API no DocuWare:

  1. Inicie sessão na sua conta DocuWare que pretende utilizar com o Power Automate
  2. No menu principal, navegue até "Configurações"
  3. Na página "Configurações", vá para a seção "Integrações" e clique no ícone para "Power Automate API Keys"
    • Se você não vir o ícone "Power Automate API Keys", é possível que seu usuário não tenha as permissões corretas. Entre em contato com o administrador do DocuWare para resolver isso.
  4. Clique no botão "Criar chave de API"
  5. Preencha os valores "Nome" e "Descrição" (opcional) e clique em "Criar"
    • Depois de pressionar "Criar", pode haver um ligeiro atraso à medida que o processo de configuração cria a sua chave.
    • Além disso, certifique-se de salvar sua chave de API. Esta será a sua única oportunidade de ver a chave de API completa. Se perder esta chave, terá de criar outra.

Neste ponto, agora você tem uma chave de API válida que pode ser usada no Power Automate para criar uma conexão com o DocuWare. Essa conexão pode ser usada com o DocuWare Power Automate Connector.

Introdução ao conector

Criar uma conexão no Power Automate é fácil e pode ser feito quando você está criando seus fluxos.

Siga estes passos para criar uma nova ligação no Power Automate:

  1. Iniciar sessão no Power Automate
  2. Criar um novo fluxo ou abrir um fluxo existente
  3. Adicione uma atividade do conector do DocuWare Power Automate ao seu fluxo
    • Clique em "+ Nova etapa" para adicionar uma nova etapa ao seu fluxo
    • Quando lhe for apresentado "Escolher uma operação", selecione "Todos" na seleção de categoria e, em seguida, digite "DocuWare" no campo de pesquisa.
    • Selecione o conector "DocuWare" e, em seguida, escolha a partir da lista de ações disponíveis.
  4. Quando a ação for adicionada ao fluxo, você será solicitado a criar uma nova conexão.
  5. Insira um nome de conexão ("Nome da conexão") e a chave de API ("Chave de API") que você recebeu do DocuWare na seção anterior e clique em "Criar".

A partir deste ponto, todas as atividades adicionadas a partir do conector DocuWare usarão essa conexão. Você pode criar conexões adicionais clicando no botão "..." no canto superior direito de uma atividade e, em seguida, clicando em "+ Adicionar nova ligação" na parte inferior do menu que aparece.

Problemas conhecidos e limitações

No momento, o conector Power Automate do DocuWare não é suportado no novo designer Power Automate Flow.

Erros e soluções comuns

Códigos de erro HTTP:

  • 400: Certifique-se de ter preenchido todos os campos obrigatórios na atividade. Alguns campos são obrigatórios e devem ser preenchidos antes que a atividade possa ser executada.
  • 401: Certifique-se de ter inserido a chave de API correta. Você também pode verificar o status da chave de API na página "Configurações", em "Integrações" -> "Power Automate API Keys".
  • 404: Certifique-se de que o documento especificado e/ou gabinete de arquivos existem e que você tem acesso a eles. Se o documento ou gabinete de arquivo não existir, ou você não tiver acesso a eles, então você receberá um erro 404.
  • 500: Este é um erro genérico que pode ser causado por uma série de problemas diferentes. Se você receber esse erro, entre em contato com o Suporte do DocuWare para obter assistência.

FAQ

Melhores práticas

A seguir estão algumas das práticas recomendadas que recomendamos ao usar o DocuWare Power Automate Connector:

  • Sempre use um usuário dedicado do DocuWare para autenticar com o DocuWare Power Automate Connector. Isso permitirá que você rastreie e gerencie facilmente as ações que estão sendo executadas pelo conector.
  • Comece testando seu fluxo com a atividade "Obter organização". Esta é a ação mais básica fornecida no DocuWare Power Automate Connector e permitirá que você verifique se sua conexão está funcionando corretamente.

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
chave de API securestring A chave da API para acessar o DocuWare Verdade

Limites de Limitação

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

Ações

Anexar um ficheiro

Acrescenta um arquivo/seção a um documento existente.
Armazenar para arquivar gabinete

Armazena um novo documento em um gabinete de arquivos.
Atualizar campos de índice

Atualiza os campos de índice de um documento.
Coloque um carimbo

Coloca um carimbo num documento.
Descarregar um documento

Baixa um documento de um gabinete de arquivos ou bandeja de documentos.
Documentos de transferência

Move um ou mais documentos de um gabinete de arquivos/bandeja de documentos para outro.
Eliminar um documento

Exclui um documento de um gabinete de arquivos ou bandeja de documentos.
Eliminar um ficheiro

Exclui um arquivo/seção de um documento existente.
Importar para a bandeja do documento

Importe um novo documento para uma bandeja de documentos.
Listar documentos na bandeja de documentos

Liste documentos da bandeja de documentos especificada.
Obtenha organização

Obtenha o nome da organização.
Obter campos de carimbo

Obtém uma lista de campos para um carimbo.
Obter campos de diálogo

Obtém os campos para uma caixa de diálogo
Obter campos de gabinete de arquivos

Obtém uma lista de campos para um gabinete de arquivos.
Obter diálogos

Obtém uma lista de caixas de diálogo para um gabinete de arquivos ou bandeja de documentos.
Obter gabinetes de arquivos e bandejas de documentos

Obtém uma lista de gabinetes de arquivos e/ou bandejas de documentos.
Obter informações do documento

Obtém informações sobre um documento.
Obter selos

Obtém uma lista de carimbos para um gabinete de arquivos ou bandeja de documentos.
Pesquisar no gabinete de arquivos

Pesquise em um gabinete de arquivos por documentos que correspondam aos critérios especificados.
Substituir um ficheiro

Substitui um arquivo/seção em um documento existente.
Transferir um ficheiro

Baixa um arquivo/seção de um documento armazenado em um gabinete de arquivos ou bandeja de documentos.

Anexar um ficheiro

ID da Operação:
AppendFile

Acrescenta um arquivo/seção a um documento existente.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocID True string

Especifique o ID do documento a ser anexado.
Conteúdo do arquivo
 file file

Especifique o conteúdo do arquivo a ser armazenado.

Devoluções

Name Caminho Tipo Description
Status da assinatura
 SignatureStatus array of string

Status da assinatura
SectionId
 SectionId string

SectionId
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 OriginalFileName string

Nome_do_arquivo original
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 AnnotationsPreview boolean

AnotaçõesPré-visualização

Armazenar para arquivar gabinete

ID da Operação:
StoreToFileCabinet

Armazena um novo documento em um gabinete de arquivos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivos
 FileCabinet True string

Selecione o gabinete de arquivos para armazenar.
Caixa de diálogo Armazenar
 StoreDialogId True string

Selecione a caixa de diálogo de armazenamento a ser usada para armazenamento.
Dados de índice
 index string

Especifique os dados de índice para o documento.
Conteúdo do arquivo
 file file

Especifique o conteúdo do arquivo a ser armazenado.

Devoluções

Name Caminho Tipo Description
Secções
 Sections array of object

Secções
Status da assinatura
 Sections.SignatureStatus array of string

Status da assinatura
SectionId
 Sections.SectionId string

SectionId
Tipo de conteúdo
 Sections.ContentType string

Tipo de conteúdo
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 Sections.OriginalFileName string

Nome_do_arquivo original
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 Sections.AnnotationsPreview boolean

AnotaçõesPré-visualização
ID do documento
 DocumentId integer

ID do documento
IndexFields
 IndexFields object

IndexFields
Título do Documento
 DocumentTitle string

Título do Documento
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isSuprimido
 DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 DocumentFlags.isEmail boolean

isEmail

Atualizar campos de índice

ID da Operação:
UpdateIndexFields

Atualiza os campos de índice de um documento.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivos
 FileCabinetID True string

Selecione o Gabinete de arquivos com o documento a ser atualizado.
ID do documento
 DocumentID True integer

Especifique o ID do documento a ser atualizado.
Nome
 Name string

Selecione ou especifique um campo de índice.
Valor
 Value string

Especifique um valor de índice.

Devoluções

Name Caminho Tipo Description
Secções
 Sections array of object

Secções
Status da assinatura
 Sections.SignatureStatus array of string

Status da assinatura
SectionId
 Sections.SectionId string

SectionId
Tipo de conteúdo
 Sections.ContentType string

Tipo de conteúdo
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 Sections.OriginalFileName string

Nome_do_arquivo original
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 Sections.AnnotationsPreview boolean

AnotaçõesPré-visualização
ID do documento
 DocumentId integer

ID do documento
IndexFields
 IndexFields object

IndexFields
Título do Documento
 DocumentTitle string

Título do Documento
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isSuprimido
 DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 DocumentFlags.isEmail boolean

isEmail

Coloque um carimbo

ID da Operação:
PlaceAStamp

Coloca um carimbo num documento.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinetID True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentID True integer

Especifique o ID do documento que pretende carimbar.
Número do processo
 FileNumber True integer

Especifique o ficheiro/secção que contém a página a carimbar.
Número da página
 PageNumber True integer

Especifique o número da página em que o carimbo será colocado.
Camada
 Layer True integer

Especifique a camada do documento para colocar o carimbo em [1-5]
Posição horizontal (posição X)
 PositionX number

[Opcional] Posição a partir da borda esquerda da página em mm.
Posição vertical (posição Y)
 PositionY number

[Opcional] Posição a partir do bordo superior da página, em mm.
Carimbo
 StampId True string

Selecione ou especifique o carimbo a ser usado.
Palavra-passe
 Password string

Especifique a senha para o carimbo (se necessário).
Nome
 Name string

Especifique um nome de campo.
Valor
 Value string

Especifique um valor de campo.

Devoluções

Name Caminho Tipo Description
User
 Created.User string

User
Time
 Created.Time string

Time
Tipo
 Type string

Tipo
Cor
 Color string

Cor
Rotação
 Rotation integer

Rotação
Transparent
 Transparent boolean

Transparent
StrokeWidth
 StrokeWidth integer

StrokeWidth
Guia
 Guid string

Guia

Descarregar um documento

ID da Operação:
DownloadDocument

Baixa um documento de um gabinete de arquivos ou bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinetID True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentId True integer

Especifique o ID do documento que pretende transferir.
Formato do documento
 DocumentFormat True string

Selecione o formato do documento baixado.

Devoluções

Body

Body
binary

Documentos de transferência

ID da Operação:
TransferDocument

Move um ou mais documentos de um gabinete de arquivos/bandeja de documentos para outro.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo de destino/bandeja de documentos
 DestinationFileCabinetID True string

Selecione o gabinete de arquivos ou a bandeja de documentos de destino.
Caixa de diálogo Armazenar
 StoreDialogID string

Selecione a caixa de diálogo de armazenamento para indexar os documentos que estão sendo movidos.
Gabinete do arquivo de origem/bandeja do documento
 SourceFileCabinetId True string

Selecione o gabinete de arquivos ou a bandeja de documentos de origem.
ID
 DocumentId integer

Especifique um ID de documento.
Nome
 Name string

Selecione ou especifique um nome de campo.
Valor
 Value string

Especifique um valor de campo.
Manter a fonte
 KeepSource boolean

Escolha se os documentos-fonte devem ser excluídos ou não.
Preencher Intellix
 FillIntellix boolean

Escolha se a indexação inteligente deve ser usada ao armazenar.

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Documents
 Documents array of object

Documents
Secções
 Documents.Sections array of object

Secções
Status da assinatura
 Documents.Sections.SignatureStatus array of string

Status da assinatura
SectionId
 Documents.Sections.SectionId string

SectionId
Tipo de conteúdo
 Documents.Sections.ContentType string

Tipo de conteúdo
HaveMorePages
 Documents.Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Documents.Sections.PageCount integer

PageCount
Tamanho do arquivo
 Documents.Sections.FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 Documents.Sections.OriginalFileName string

Nome_do_arquivo original
ContentModified
 Documents.Sections.ContentModified string

ContentModified
HasTextAnnotation
 Documents.Sections.HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 Documents.Sections.AnnotationsPreview boolean

AnotaçõesPré-visualização
ID do documento
 Documents.DocumentId integer

ID do documento
IndexFields
 Documents.IndexFields object

IndexFields
Título do Documento
 Documents.DocumentTitle string

Título do Documento
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 Documents.ContentType string

Tipo de conteúdo
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isSuprimido
 Documents.DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Eliminar um documento

ID da Operação:
DeleteDocument

Exclui um documento de um gabinete de arquivos ou bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinetID True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentID True integer

Especifique o ID do documento que pretende eliminar.

Eliminar um ficheiro

ID da Operação:
DeleteFile

Exclui um arquivo/seção de um documento existente.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento a ser excluído.
Número do processo
 FileNumber True integer

Especifique o número do arquivo a ser excluído.

Importar para a bandeja do documento

ID da Operação:
ImportToDocumentTray

Importe um novo documento para uma bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Tabuleiro do documento
 DocumentTray True string

Selecione a bandeja de documentos para a qual importar.
Caixa de diálogo Armazenar
 StoreDialogId string

Selecione a caixa de diálogo de armazenamento a ser usada durante a importação.
Dados de índice
 index string

Especifique os dados de índice para o documento.
Conteúdo do arquivo
 file file

Especifique o conteúdo do arquivo a ser importado.

Devoluções

Name Caminho Tipo Description
Secções
 Sections array of object

Secções
Status da assinatura
 Sections.SignatureStatus array of string

Status da assinatura
SectionId
 Sections.SectionId string

SectionId
Tipo de conteúdo
 Sections.ContentType string

Tipo de conteúdo
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 Sections.OriginalFileName string

Nome_do_arquivo original
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 Sections.AnnotationsPreview boolean

AnotaçõesPré-visualização
ID do documento
 DocumentId integer

ID do documento
IndexFields
 IndexFields object

IndexFields
Título do Documento
 DocumentTitle string

Título do Documento
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isSuprimido
 DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 DocumentFlags.isEmail boolean

isEmail

Listar documentos na bandeja de documentos

ID da Operação:
ListDocumentsInDocumentTray

Liste documentos da bandeja de documentos especificada.

Parâmetros

Name Chave Necessário Tipo Description
Tabuleiro do documento
 DocumentTray True string

Selecione a bandeja de documentos para pesquisar.

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Documents
 Documents array of object
Secções
 Documents.Sections array of

Secções
ID do documento
 Documents.DocumentId integer

ID do documento
IndexFields
 Documents.IndexFields object

IndexFields
Título do Documento
 Documents.DocumentTitle string

Título do Documento
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 Documents.ContentType string

Tipo de conteúdo
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isSuprimido
 Documents.DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Obtenha organização

ID da Operação:
GetOrganization

Obtenha o nome da organização.

Devoluções

Name Caminho Tipo Description
Nome
 Name string

Nome

Obter campos de carimbo

ID da Operação:
GetStampFields

Obtém uma lista de campos para um carimbo.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o carimbo desejado.
Carimbo
 Stamp True string

Selecione o carimbo para obter seus campos.

Devoluções

Name Caminho Tipo Description
Campos
 Fields array of object

Campos
Id
 Fields.Id string

Id
Etiqueta
 Fields.Label string

Etiqueta
Nome de Exibição
 Fields.DisplayName string

Nome de Exibição
ID da Operação:
GetDialogFields

Obtém os campos para uma caixa de diálogo

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivos
 FileCabinet True string

Selecione o gabinete de arquivos
Dialog
 DialogId True string

Selecione a caixa de diálogo para obter os campos.

Devoluções

Name Caminho Tipo Description
Campos
 Fields array of object

Campos
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
Nome de Exibição
 Fields.DisplayName string

Nome de Exibição
ReadOnly
 Fields.ReadOnly boolean

ReadOnly
Visível
 Fields.Visible boolean

Visível

Obter campos de gabinete de arquivos

ID da Operação:
GetFileCabinetFields

Obtém uma lista de campos para um gabinete de arquivos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivos
 FileCabinet True string

Selecione o Gabinete de arquivos para obter campos.
Tipo de campo
 FieldType string

Selecione o tipo de campos a serem retornados.

Devoluções

Name Caminho Tipo Description
Campos
 Fields array of object

Campos
TableFieldColumns
 Fields.TableFieldColumns array of object

TableFieldColumns
DBFieldName
 Fields.TableFieldColumns.DBFieldName string

DBFieldName
DWFieldType
 Fields.TableFieldColumns.DWFieldType string

DWFieldType
Nome de Exibição
 Fields.TableFieldColumns.DisplayName string

Nome de Exibição
DropLeadingBlanks
 Fields.TableFieldColumns.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.TableFieldColumns.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.TableFieldColumns.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.TableFieldColumns.FixedEntry string

FixedEntry
Length
 Fields.TableFieldColumns.Length integer

Length
NotEmpty
 Fields.TableFieldColumns.NotEmpty boolean

NotEmpty
Precisão
 Fields.TableFieldColumns.Precision integer

Precisão
Scope
 Fields.TableFieldColumns.Scope string

Scope
UsedAsDocumentName
 Fields.UsedAsDocumentName boolean

UsedAsDocumentName
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
Nome de Exibição
 Fields.DisplayName string

Nome de Exibição
DropLeadingBlanks
 Fields.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.FixedEntry string

FixedEntry
Length
 Fields.Length integer

Length
NotEmpty
 Fields.NotEmpty boolean

NotEmpty
Precisão
 Fields.Precision integer

Precisão
Scope
 Fields.Scope string

Scope

Obter diálogos

ID da Operação:
GetDialogs

Obtém uma lista de caixas de diálogo para um gabinete de arquivos ou bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos para obter caixas de diálogo.
Tipo de caixa de diálogo
 DialogType string

Selecione o tipo de caixas de diálogo a serem retornadas.

Devoluções

Name Caminho Tipo Description
Dialogs
 Dialogs array of object

Dialogs
Nome
 Dialogs.Name string

Nome
Guia
 Dialogs.Guid string

Guia
Cor
 Dialogs.Color string

Cor
IsDefault
 Dialogs.IsDefault boolean

IsDefault
Tipo
 Dialogs.Type string

Tipo
FileCabinetId
 Dialogs.FileCabinetId string

FileCabinetId

Obter gabinetes de arquivos e bandejas de documentos

ID da Operação:
GetFileCabinets

Obtém uma lista de gabinetes de arquivos e/ou bandejas de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de gabinete de arquivo
 FileCabinetType True string

Selecione os tipos que deseja que sejam devolvidos.

Devoluções

Name Caminho Tipo Description
Gabinetes de arquivo
 FileCabinets array of object

Gabinetes de arquivo
Nome
 FileCabinets.Name string

Nome
Guia
 FileCabinets.Guid string

Guia
Cor
 FileCabinets.Color string

Cor
IsTray
 FileCabinets.IsTray boolean

IsTray

Obter informações do documento

ID da Operação:
GetDocumentInformation

Obtém informações sobre um documento.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinetID True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentID True integer

Especifique o ID do documento sobre o qual pretende obter informações.

Devoluções

Name Caminho Tipo Description
Secções
 Sections array of object

Secções
Status da assinatura
 Sections.SignatureStatus array of string

Status da assinatura
SectionId
 Sections.SectionId string

SectionId
Tipo de conteúdo
 Sections.ContentType string

Tipo de conteúdo
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 Sections.OriginalFileName string

Nome_do_arquivo original
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 Sections.AnnotationsPreview boolean

AnotaçõesPré-visualização
ID do documento
 DocumentId integer

ID do documento
IndexFields
 IndexFields object

IndexFields
Título do Documento
 DocumentTitle string

Título do Documento
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isSuprimido
 DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 DocumentFlags.isEmail boolean

isEmail

Obter selos

ID da Operação:
GetStamps

Obtém uma lista de carimbos para um gabinete de arquivos ou bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos para obter carimbos.

Devoluções

Name Caminho Tipo Description
Carimbos
 Stamps array of object

Carimbos
Id
 Stamps.Id string

Id
Nome
 Stamps.Name string

Nome
Nome de Exibição
 Stamps.DisplayName string

Nome de Exibição
Cor
 Stamps.Color string

Cor
Signature
 Stamps.Signature string

Signature
Protegido por palavra-passe
 Stamps.PasswordProtected boolean

Protegido por palavra-passe
Substituir
 Stamps.Overwrite boolean

Substituir
Tipo
 Stamps.Type string

Tipo
FileCabinetId
 Stamps.FileCabinetId string

FileCabinetId

Pesquisar no gabinete de arquivos

ID da Operação:
SearchForDocumentsInFileCabinet

Pesquise em um gabinete de arquivos por documentos que correspondam aos critérios especificados.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivos
 FileCabinet True string

Selecione o gabinete de arquivos para pesquisar.
Caixa de diálogo Pesquisar
 SearchDialogId True string

Selecione a caixa de diálogo de pesquisa a ser usada para pesquisar.
Consulta de pesquisa
 SearchQuery True

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Documents
 Documents array of object

Documents
Secções
 Documents.Sections array of

Secções
ID do documento
 Documents.DocumentId integer

ID do documento
IndexFields
 Documents.IndexFields object

IndexFields
Título do Documento
 Documents.DocumentTitle string

Título do Documento
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
Tipo de conteúdo
 Documents.ContentType string

Tipo de conteúdo
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceDisponível
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceDisponível
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isSuprimido
 Documents.DocumentFlags.isDeleted boolean

isSuprimido
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Substituir um ficheiro

ID da Operação:
ReplaceFile

Substitui um arquivo/seção em um documento existente.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinet True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento com o arquivo a ser substituído.
Número do processo
 FileNumber True integer

Especifique o número do arquivo a ser substituído.
Conteúdo do arquivo
 file file

Especifique o conteúdo do arquivo a ser armazenado.

Devoluções

Name Caminho Tipo Description
Status da assinatura
 SignatureStatus array of string

Status da assinatura
SectionId
 SectionId string

SectionId
Tipo de conteúdo
 ContentType string

Tipo de conteúdo
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
Nome_do_arquivo original
 OriginalFileName string

Nome_do_arquivo original
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnotaçõesPré-visualização
 AnnotationsPreview boolean

AnotaçõesPré-visualização

Transferir um ficheiro

ID da Operação:
DownloadFile

Baixa um arquivo/seção de um documento armazenado em um gabinete de arquivos ou bandeja de documentos.

Parâmetros

Name Chave Necessário Tipo Description
Gabinete de arquivo/bandeja de documentos
 FileCabinetID True string

Selecione o Gabinete de arquivos ou a bandeja de documentos com o documento.
ID do documento
 DocumentId True integer

Especifique o ID do documento com o arquivo que você deseja baixar.
Número do processo
 FileNumber True string

Especifique o número do ficheiro que pretende transferir.
Formato do documento
 DocumentFormat True string

Selecione o formato do documento baixado.

Devoluções

Body

Body
binary

Definições

binário

Este é o tipo de dados básico 'binário'.