Compartilhar via

DocuWare

Acesse recursos comuns do DocuWare de dentro de seus fluxos.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome DocuWare GmbH
URL https://support.docuware.com
Email support@docuware.com
Metadados do conector
Publicador DocuWare
Site https://start.docuware.com
Política de privacidade https://start.docuware.com/data-privacy
Categorias Conteúdo e arquivos; Produtividade

O DocuWare fornece uma API REST avançada e extensa. Com o Conector do Power Automate 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 satisfaçam totalmente suas necessidades comerciais, graças à integração perfeita com o DocuWare.

Pré-requisitos

Você precisará do seguinte para continuar:

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

Como obter credenciais

A criação de uma nova chave de API é fácil e pode ser feita de dentro do DocuWare.

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

  1. Faça logon em sua conta do DocuWare que você deseja usar 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 "Chaves de API do Power Automate"
    • Se você não vir o ícone "Chaves de API do Power Automate", é possível que o 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 pequeno atraso à medida que o processo de configuração cria sua chave.
    • Além disso, salve sua Chave de API. Essa será sua única oportunidade de exibir a Chave de API completa. Se você perder essa chave, precisará 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 Conector do DocuWare Power Automate.

Introdução ao conector

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

Siga estas etapas para criar uma nova conexão no Power Automate:

  1. Fazer logon no Power Automate
  2. Criar um novo fluxo ou abrir um fluxo existente
  3. Adicionar uma atividade do conector do DocuWare Power Automate ao seu fluxo
    • Clique em "+ Nova Etapa" para adicionar uma nova etapa ao seu fluxo
    • Quando apresentado com "Escolher uma operação", selecione "Todos" na seleção de categoria e digite "DocuWare" no campo de pesquisa.
    • Selecione o conector "DocuWare" e escolha na 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".

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

Problemas e limitações conhecidos

No momento, não há suporte para o conector do Power Automate do DocuWare no novo designer de Fluxo do Power Automate.

Erros e soluções comuns

Códigos de erro HTTP:

  • 400: Verifique se você preencheu todos os campos necessários na atividade. Alguns campos são necessários e devem ser preenchidos antes que a atividade possa ser executada.
  • 401: Verifique se você inseriu a chave de API correta. Você também pode verificar o status da Chave de API na página "Configurações", em "Integrações" –> "Chaves de API do Power Automate".
  • 404: Verifique se o documento especificado e/ou o gabinete de arquivos existem e se você tem acesso a eles. Se o gabinete de documentos ou arquivos não existir ou você não tiver acesso a eles, você receberá um erro 404.
  • 500: Esse é um erro genérico que pode ser causado por vários problemas diferentes. Se você receber esse erro, entre em contato com o Suporte do DocuWare para obter assistência.

perguntas frequentes

Práticas recomendadas

Veja a seguir algumas das práticas recomendadas que recomendamos ao usar o Conector do DocuWare Power Automate:

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

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

Limitações

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

Ações

Acrescentar um arquivo

Acrescenta um arquivo/seção a um documento existente.
Armazenar no gabinete de arquivos

Armazena um novo documento em um armário de arquivos.
Atualizar campos de índice

Atualiza os campos de índice de um documento.
Baixar um arquivo

Baixa um arquivo/seção de um documento armazenado em um armário de arquivos ou bandeja de documentos.
Baixar um documento

Baixa um documento de um armário de arquivos ou bandeja de documentos.
Colocar um carimbo

Coloca um carimbo em um documento.
Excluir um arquivo

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

Exclui um documento de um armário de arquivos ou bandeja de documentos.
Importar para a bandeja de documentos

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

Listar documentos da bandeja de documento especificada.
Obter armários de arquivos e bandejas de documentos

Obtém uma lista de armários de arquivos e/ou bandejas de documentos.
Obter caixas de diálogo

Obtém uma lista de caixas de diálogo para um armário de arquivos ou bandeja de documentos.
Obter campos de diálogo

Obtém os campos de uma caixa de diálogo
Obter campos de selo

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

Obtém uma lista de campos para um gabinete de arquivos.
Obter informações do documento

Obtém informações sobre um documento.
Obter organização

Obtenha o nome da organização.
Obter selos

Obtém uma lista de selos para um armário de arquivos ou bandeja de documentos.
Pesquisar no gabinete de arquivos

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

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

Move um ou mais documentos de uma bandeja de arquivo/documento para outra.

Acrescentar um arquivo

ID da operação:
AppendFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocID True string

Especifique a ID do documento ao qual acrescentar.
Conteúdo do Arquivo
 file file

Especifique o conteúdo do arquivo a ser armazenado.

Retornos

Nome Caminho Tipo Description
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
ContentType
 ContentType string

ContentType
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

Armazenar no gabinete de arquivos

ID da operação:
StoreToFileCabinet

Armazena um novo documento em um armário de arquivos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Gabinete de Arquivos
 FileCabinet True string

Selecione o Gabinete de Arquivos para o qual armazenar.
Caixa de diálogo Armazenar
 StoreDialogId True string

Selecione a caixa de diálogo do repositório a ser usada para armazenar.
Dados de índice
 index string

Especifique os dados de índice do documento.
Conteúdo do Arquivo
 file file

Especifique o conteúdo do arquivo a ser armazenado.

Retornos

Nome Caminho Tipo Description
Seções
 Sections array of object

Seções
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Atualizar campos de índice

ID da operação:
UpdateIndexFields

Atualiza os campos de índice de um documento.

Parâmetros

Nome Chave Obrigató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 a ID do documento a ser atualizado.
Nome
 Name string

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

Especifique um valor de índice.

Retornos

Nome Caminho Tipo Description
Seções
 Sections array of object

Seções
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Baixar um arquivo

ID da operação:
DownloadFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinetID True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentId True integer

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

Especifique o número do arquivo que você deseja baixar.
Formato do documento
 DocumentFormat True string

Selecione o formato do documento baixado.

Retornos

Corpo

Corpo
binary

Baixar um documento

ID da operação:
DownloadDocument

Baixa um documento de um armário de arquivos ou bandeja de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinetID True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentId True integer

Especifique a ID do documento que você deseja baixar.
Formato do documento
 DocumentFormat True string

Selecione o formato do documento baixado.

Retornos

Corpo

Corpo
binary

Colocar um carimbo

ID da operação:
PlaceAStamp

Coloca um carimbo em um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinetID True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento que você deseja carimbar.
Número do Arquivo
 FileNumber True integer

Especifique o arquivo/seção que contém a página a ser carimbada.
Número da Página
 PageNumber True integer

Especifique o número da página no qual colocar o carimbo.
Camada
 Layer True integer

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

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

[Opcional] Posicione a partir da borda superior da página em mm.
Selo
 StampId True string

Selecione ou especifique o carimbo a ser usado.
Senha
 Password string

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

Especifique um nome de campo.
Value
 Value string

Especifique um valor de campo.

Retornos

Nome Caminho Tipo Description
Utilizador
 Created.User string

Utilizador
Hora
 Created.Time string

Hora
Tipo
 Type string

Tipo
Cor
 Color string

Cor
Rotation
 Rotation integer

Rotation
Transparent
 Transparent boolean

Transparent
StrokeWidth
 StrokeWidth integer

StrokeWidth
Guid
 Guid string

Guid

Excluir um arquivo

ID da operação:
DeleteFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento do qual excluir.
Número do Arquivo
 FileNumber True integer

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

Excluir um documento

ID da operação:
DeleteDocument

Exclui um documento de um armário de arquivos ou bandeja de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinetID True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento que você deseja excluir.

Importar para a bandeja de documentos

ID da operação:
ImportToDocumentTray

Importe um novo documento para uma bandeja de documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bandeja de documentos
 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 do repositório a ser usada durante a importação.
Dados de índice
 index string

Especifique os dados de índice do documento.
Conteúdo do Arquivo
 file file

Especifique o conteúdo do arquivo a ser importado.

Retornos

Nome Caminho Tipo Description
Seções
 Sections array of object

Seções
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Listar documentos na bandeja do documento

ID da operação:
ListDocumentsInDocumentTray

Listar documentos da bandeja de documento especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bandeja de documentos
 DocumentTray True string

Selecione a Bandeja de Documentos a ser pesquisada.

Retornos

Nome Caminho Tipo Description
Contagem
 Count integer

Contagem
Documentos
 Documents array of object
Seções
 Documents.Sections array of

Seções
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
ContentType
 Documents.ContentType string

ContentType
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
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Obter armários de arquivos e bandejas de documentos

ID da operação:
GetFileCabinets

Obtém uma lista de armários de arquivos e/ou bandejas de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de Gabinete de Arquivo
 FileCabinetType True string

Selecione quais tipos você deseja retornar.

Retornos

Nome Caminho Tipo Description
FileCabinets
 FileCabinets array of object

FileCabinets
Nome
 FileCabinets.Name string

Nome
Guid
 FileCabinets.Guid string

Guid
Cor
 FileCabinets.Color string

Cor
IsTray
 FileCabinets.IsTray boolean

IsTray
ID da operação:
GetDialogs

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos do qual obter diálogos.
Tipo de caixa de diálogo
 DialogType string

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

Retornos

Nome Caminho Tipo Description
Dialogs
 Dialogs array of object

Dialogs
Nome
 Dialogs.Name string

Nome
Guid
 Dialogs.Guid string

Guid
Cor
 Dialogs.Color string

Cor
IsDefault
 Dialogs.IsDefault boolean

IsDefault
Tipo
 Dialogs.Type string

Tipo
FileCabinetId
 Dialogs.FileCabinetId string

FileCabinetId
ID da operação:
GetDialogFields

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

Parâmetros

Nome Chave Obrigató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 a qual obter os campos.

Retornos

Nome Caminho Tipo Description
Fields
 Fields array of object

Fields
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
DisplayName
 Fields.DisplayName string

DisplayName
ReadOnly
 Fields.ReadOnly boolean

ReadOnly
Visível
 Fields.Visible boolean

Visível

Obter campos de selo

ID da operação:
GetStampFields

Obtém uma lista de campos para um carimbo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com o carimbo desejado.
Selo
 Stamp True string

Selecione o carimbo para obter seus campos.

Retornos

Nome Caminho Tipo Description
Fields
 Fields array of object

Fields
ID
 Fields.Id string

ID
Etiqueta
 Fields.Label string

Etiqueta
DisplayName
 Fields.DisplayName string

DisplayName

Obter campos do gabinete de arquivos

ID da operação:
GetFileCabinetFields

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Gabinete de Arquivos
 FileCabinet True string

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

Selecione o tipo de campos a serem retornados.

Retornos

Nome Caminho Tipo Description
Fields
 Fields array of object

Fields
TableFieldColumns
 Fields.TableFieldColumns array of object

TableFieldColumns
DBFieldName
 Fields.TableFieldColumns.DBFieldName string

DBFieldName
DWFieldType
 Fields.TableFieldColumns.DWFieldType string

DWFieldType
DisplayName
 Fields.TableFieldColumns.DisplayName string

DisplayName
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
DisplayName
 Fields.DisplayName string

DisplayName
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 informações do documento

ID da operação:
GetDocumentInformation

Obtém informações sobre um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinetID True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento no qual você deseja obter informações.

Retornos

Nome Caminho Tipo Description
Seções
 Sections array of object

Seções
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamanho do arquivo
 Sections.FileSize integer

Tamanho do arquivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Obter organização

ID da operação:
GetOrganization

Obtenha o nome da organização.

Retornos

Nome Caminho Tipo Description
Nome
 Name string

Nome

Obter selos

ID da operação:
GetStamps

Obtém uma lista de selos para um armário de arquivos ou bandeja de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos do qual obter selos.

Retornos

Nome Caminho Tipo Description
Álbum
 Stamps array of object

Álbum
ID
 Stamps.Id string

ID
Nome
 Stamps.Name string

Nome
DisplayName
 Stamps.DisplayName string

DisplayName
Cor
 Stamps.Color string

Cor
Signature
 Stamps.Signature string

Signature
PasswordProtected
 Stamps.PasswordProtected boolean

PasswordProtected
Sobrescrever
 Stamps.Overwrite boolean

Sobrescrever
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 documentos que correspondam aos critérios especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Gabinete de Arquivos
 FileCabinet True string

Selecione o Gabinete de Arquivos a ser pesquisado.
Caixa de diálogo Pesquisar
 SearchDialogId True string

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

Retornos

Nome Caminho Tipo Description
Contagem
 Count integer

Contagem
Documentos
 Documents array of object

Documentos
Seções
 Documents.Sections array of

Seções
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
ContentType
 Documents.ContentType string

ContentType
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
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Substituir um arquivo

ID da operação:
ReplaceFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Armário de Arquivos/Bandeja de Documentos
 FileCabinet True string

Selecione o Gabinete de Arquivos ou a Bandeja de Documentos com seu documento.
ID do documento
 DocumentID True integer

Especifique a ID do documento com o arquivo a ser substituído.
Número do Arquivo
 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.

Retornos

Nome Caminho Tipo Description
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
ContentType
 ContentType string

ContentType
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamanho do arquivo
 FileSize integer

Tamanho do arquivo
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

Transferir documentos

ID da operação:
TransferDocument

Move um ou mais documentos de uma bandeja de arquivo/documento para outra.

Parâmetros

Nome Chave Obrigatório Tipo Description
Gabinete de Arquivo de Destino/Bandeja de Documentos
 DestinationFileCabinetID True string

Selecione o Gabinete de Arquivos de destino ou a Bandeja de Documentos.
Caixa de diálogo Armazenar
 StoreDialogID string

Selecione a caixa de diálogo do repositório para indexar os documentos que estão sendo movidos.
Gabinete de Arquivo de Origem/Bandeja de Documentos
 SourceFileCabinetId True string

Selecione o Gabinete de Arquivos de origem ou a Bandeja de Documentos.
ID
 DocumentId integer

Especifique uma ID do documento.
Nome
 Name string

Selecione ou especifique um nome de campo.
Value
 Value string

Especifique um valor de campo.
Manter origem
 KeepSource boolean

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

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

Retornos

Nome Caminho Tipo Description
Contagem
 Count integer

Contagem
Documentos
 Documents array of object

Documentos
Seções
 Documents.Sections array of object

Seções
SignatureStatus
 Documents.Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Documents.Sections.SectionId string

SectionId
ContentType
 Documents.Sections.ContentType string

ContentType
HaveMorePages
 Documents.Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Documents.Sections.PageCount integer

PageCount
Tamanho do arquivo
 Documents.Sections.FileSize integer

Tamanho do arquivo
OriginalFileName
 Documents.Sections.OriginalFileName string

OriginalFileName
ContentModified
 Documents.Sections.ContentModified string

ContentModified
HasTextAnnotation
 Documents.Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Documents.Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamanho do arquivo
 Documents.FileSize integer

Tamanho do arquivo
ContentType
 Documents.ContentType string

ContentType
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
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Definições

binário

Esse é o tipo de dados básico 'binary'.