Redque (Pré-visualização)
Acesso e gestão do sistema Redque.
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 | Redque sr.o. |
| URL | https://redque.com |
| info@redque.com |
| Metadados do conector | |
|---|---|
| Editora | Redque sr.o. |
| Sítio Web | https://redque.cz/en/ |
| Política de privacidade | https://redque.cz/policy.html |
| Categorias | IA; Finanças |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar permissões |
Adiciona permissões ao usuário. |
| Alterar a palavra-passe do utilizador |
Altera a senha do usuário especificado. Requer permissão de gerenciamento de usuários. |
| Alterar palavra-passe |
Altera a senha do usuário. |
| Atualizar dados da pasta |
Atualiza os dados da pasta. |
| Atualizar documento |
Atualiza o documento. |
| Atualizar enum específico |
Atualiza um enum específico. |
| Atualizar retorno à configuração do remetente |
As atualizações retornam à configuração do remetente. |
| Atualizar utilizador |
Atualiza parcialmente um usuário especificado. |
| Bloquear documento |
Bloqueia (abre) o documento impedindo que outros usuários o modifiquem. |
| Carregar um documento e programá-lo para processamento |
Carrega o documento e agenda-o para processamento. |
| Conceder acesso ao documento ao usuário especificado |
Concede acesso ao documento ao usuário especificado. |
| Criar novo enum |
Observe que a chave enum é gerada automaticamente e as chaves de valor devem conter apenas letras minúsculas, letras maiúsculas, números, sublinhado, traço |
| Criar pasta |
Cria uma nova pasta. |
| Criar utilizador |
Cria um novo usuário. |
| Desbloquear documento bloqueado |
Desbloqueia documento bloqueado (fecha) para permitir que outros usuários modifiquem seu conteúdo. |
| Descarregar ficheiro do documento |
Transfere o ficheiro do documento. |
| Devolver o documento ao emitente para correções |
Retorna o documento ao emissor para correções no endereço de e-mail fornecido. |
| Devolver todos os enums |
Retorna a lista de todos os enums. |
| Encontrar utilizador |
Localiza um usuário. |
| Enum de retorno |
Devolve enum específico. |
| Exclui enum com id específico |
Exclui um enum específico. |
| Excluir usuário |
Exclui um usuário. |
| Extrair documento |
Solicita a extração de um documento. Depois que o documento é recuperado, ele é agendado para exclusão. |
| Filtrar documentos |
Retorna a lista de documentos com base em parâmetros. |
| Filtrar utilizadores |
Obtém a lista de usuários por critérios. |
| Gerar token |
Gera novo token de registro. |
| Imagem para uma determinada página |
Retorna uma imagem para uma determinada página. |
| Informações de licença |
Retorna informações de licença. |
| Localizar pasta |
Localiza a pasta por ID. |
| Obter documento extraído |
O documento extraído é marcado para remoção e será excluído dentro de várias horas após ser acessado. Isso dá aos usuários tempo para tentar recuperar novamente o resultado se eles falharem. |
| Obter metadados do documento |
Obtém os metadados do documento. |
| Pasta de download |
Descarrega todos os documentos numa pasta como um único arquivo. |
| Remove token |
Remove o token de registro. |
| Remover documento existente |
Remove o documento existente. |
| Remover o acesso ao documento para o usuário especificado |
Remove o acesso ao documento para o usuário especificado. |
| Remover pasta |
Remove a pasta existente. |
| Remover permissões |
Revoga as permissões do usuário. |
| Retornar à configuração do remetente |
Recupere a configuração atual para retornar à ação do remetente. |
| Token de retorno |
Retorna o token de registro atual ou nada se o token não estiver ativo. |
Adicionar permissões
Adiciona permissões ao usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
|
permissões
|
permissions | array of string |
Aceda a dados |
Alterar a palavra-passe do utilizador
Altera a senha do usuário especificado. Requer permissão de gerenciamento de usuários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
|
palavra-passe
|
password | string |
Senha do usuário |
|
|
accountId
|
accountId | string |
ID da conta do utilizador |
|
|
tecla de ativação
|
activationkey | string |
Chave de ativação do usuário |
Alterar palavra-passe
Altera a senha do usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
|
body
|
body | string |
Palavra-passe do utilizador |
Atualizar dados da pasta
Atualiza os dados da pasta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
ID da pasta |
|
folderId
|
folderId | string |
ID do documento. |
|
|
ownerId
|
ownerId | string |
ID do proprietário do contêiner |
|
|
criado
|
created | date-time |
Tempo de criação do contentor |
|
|
metadados
|
metadata | object |
Todos os cabeçalhos anexados ao contêiner |
Atualizar documento
Atualiza o documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
documentId
|
documentId | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
valor
|
value | boolean | ||
|
valor
|
value | boolean | ||
|
valor
|
value | string | ||
|
valor
|
value | string | ||
|
operação
|
operation | string | ||
|
chave
|
key | string | ||
|
mensagem
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
valor
|
value | string | ||
|
operação
|
operation | string | ||
|
chave
|
key | string | ||
|
mensagem
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
userId
|
userId | string | ||
|
userId
|
userId | string | ||
|
state
|
state | string |
Estado do documento |
|
|
valor
|
value | string | ||
|
operação
|
operation | string | ||
|
valor
|
value | string | ||
|
operação
|
operation | string |
Devoluções
Dados de resposta de status. Usado como resposta quando a solicitação não retorna dados.
- Body
- RedQueStatus
Atualizar enum específico
Atualiza um enum específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador Enum
|
id | True | string |
Identificador Enum |
|
id
|
id | string |
Identificador Enum |
|
|
nome
|
name | string |
Nome enum amigável |
|
|
values
|
values | object |
Lista de valores de enum |
|
|
isEditable
|
isEditable | boolean |
Indica se o enum pode ser editado |
Atualizar retorno à configuração do remetente
As atualizações retornam à configuração do remetente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
modelo
|
template | string | ||
|
Assunto
|
subject | string |
Atualizar utilizador
Atualiza parcialmente um usuário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
|
primeiroNome
|
firstName | string |
Nome próprio do utilizador |
|
|
sobrenome
|
lastName | string |
Apelido do utilizador |
Bloquear documento
Bloqueia (abre) o documento impedindo que outros usuários o modifiquem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Carregar um documento e programá-lo para processamento
Carrega o documento e agenda-o para processamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ficheiro
|
File | file |
Ficheiro |
|
|
ID externo do documento
|
DocumentId | string |
ID do documento externo |
|
|
ID da pasta
|
FolderId | string |
ID da pasta |
|
|
Date
|
Date | date-time |
Date |
|
|
Encomenda
|
Ordinal | integer |
Ordem utilizada para manter a ordem dos documentos que são carregados em paralelo |
|
|
O documento é um anexo
|
IsAttachment | boolean |
True se o documento for um anexo |
|
|
Classe do documento
|
DocumentClass | string |
Classe do documento |
Devoluções
Resultado do carregamento de um ficheiro
- Body
- ApiUploadResponse
Conceder acesso ao documento ao usuário especificado
Concede acesso ao documento ao usuário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
ID de utilizador
|
userId | True | string |
ID de utilizador |
|
documentId
|
documentId | string |
ID do documento |
|
|
userId
|
userId | string |
ID do utilizador |
|
|
mensagem
|
message | string |
Criar novo enum
Observe que a chave enum é gerada automaticamente e as chaves de valor devem conter apenas letras minúsculas, letras maiúsculas, números, sublinhado, traço
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | string |
Identificador Enum |
|
|
nome
|
name | string |
Nome enum amigável |
|
|
values
|
values | object |
Lista de valores de enum |
|
|
isEditable
|
isEditable | boolean |
Indica se o enum pode ser editado |
Devoluções
Valor de resposta genérico
- Body
- StringApiValue
Criar pasta
Criar utilizador
Cria um novo usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
primeiroNome
|
firstName | string |
Nome próprio do utilizador |
|
|
sobrenome
|
lastName | string |
Apelido do utilizador |
|
|
palavra-passe
|
password | string |
Palavra-passe da conta |
|
|
e-mail
|
string |
Email (nome de login) do usuário |
Desbloquear documento bloqueado
Desbloqueia documento bloqueado (fecha) para permitir que outros usuários modifiquem seu conteúdo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Descarregar ficheiro do documento
Transfere o ficheiro do documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Identificador do documento |
Devolver o documento ao emitente para correções
Retorna o documento ao emissor para correções no endereço de e-mail fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
adicionaisDocumentos
|
additionalDocuments | array of string | ||
|
destinatárioE-mail
|
recipientEmail | string | ||
|
razão
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
Devolver todos os enums
Encontrar utilizador
Localiza um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
Devoluções
Informação do utilizador
- Body
- ApiUser
Enum de retorno
Devolve enum específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador Enum
|
id | True | string |
Identificador Enum |
Devoluções
Dados de enum para o tipo de campo enum
- Body
- ApiEnum
Exclui enum com id específico
Exclui um enum específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave Enum
|
id | True | string |
Identificador/chave de enum |
Excluir usuário
Exclui um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do Utilizador |
Extrair documento
Solicita a extração de um documento. Depois que o documento é recuperado, ele é agendado para exclusão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
externalDocumentId | string |
ID do documento (opcional - o ID do documento externo) |
|
|
Ficheiro
|
file | file |
Ficheiro |
Filtrar documentos
Retorna a lista de documentos com base em parâmetros.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
enviar SMS
|
text | string |
Pesquisar texto usado para pesquisas gerais |
|
|
valor
|
value | string | ||
|
values
|
values | string |
Estado do documento |
|
|
values
|
values | string |
Estado do documento |
|
|
valor
|
value | string | ||
|
valor
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
de
|
from | date-time | ||
|
Para
|
to | date-time | ||
|
campos
|
fields | object |
Filtros de campo |
|
|
ignorar
|
skip | integer |
Quantos itens ignorar do início da lista. Permite a paginação. |
|
|
tomar
|
take | integer |
Número máximo de itens de lista que serão devolvidos |
|
|
campo
|
field | string |
Lista de propriedades nas quais os resultados podem ser classificados |
|
|
direção
|
direction | string |
Direção na qual os valores da lista são classificados |
|
|
scopes
|
scopes | string |
Escopo do documento que filtra quais partes do documento devem ser retornadas |
Devoluções
Resultado da pesquisa
Filtrar utilizadores
Obtém a lista de usuários por critérios.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
enviar SMS
|
text | string |
Pesquisar texto usado para pesquisas gerais |
|
|
valor
|
value | string | ||
|
ignorar
|
skip | integer |
Quantos itens ignorar do início da lista. Permite a paginação. |
|
|
tomar
|
take | integer |
Número máximo de itens de lista que serão devolvidos |
|
|
campo
|
field | string |
Enum para declarar parâmetros de classificação do usuário |
|
|
direção
|
direction | string |
Direção na qual os valores da lista são classificados |
Devoluções
Resultado da pesquisa
- Body
- ApiUserApiListResult
Gerar token
Imagem para uma determinada página
Retorna uma imagem para uma determinada página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Índice da página
|
pageIndex | True | integer |
Índice da página |
|
Preview
|
isPreview | boolean |
True se a imagem de tamanho reduzido deve ser retornada. |
Devoluções
- response
- uri
Informações de licença
Localizar pasta
Localiza a pasta por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador da pasta |
|
Com membros
|
withMembers | boolean |
True se documento com membros |
Devoluções
Metadados do contêiner com metadados de documentos dentro do contêiner
- Body
- ApiFolderWithMembers
Obter documento extraído
O documento extraído é marcado para remoção e será excluído dentro de várias horas após ser acessado. Isso dá aos usuários tempo para tentar recuperar novamente o resultado se eles falharem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento (fornecido pela RedQue ou externa) |
Obter metadados do documento
Obtém os metadados do documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
O ID do documento é um documento de identificação externo?
|
isExternalId | boolean |
O ID do documento é um documento de identificação externo? |
Devoluções
- Body
- ApiDocument
Pasta de download
Descarrega todos os documentos numa pasta como um único arquivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador da pasta |
Remove token
Remove o token de registro.
Remover documento existente
Remove o documento existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Remover o acesso ao documento para o usuário especificado
Remove o acesso ao documento para o usuário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Identificador do documento |
|
ID de utilizador
|
userId | True | string |
Identificador de utilizador |
Remover pasta
Remove a pasta existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador da pasta |
Remover permissões
Revoga as permissões do usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID do utilizador |
|
permissões
|
permissions | array of string |
Aceda a dados |
Retornar à configuração do remetente
Recupere a configuração atual para retornar à ação do remetente.
Token de retorno
Retorna o token de registro atual ou nada se o token não estiver ativo.
Devoluções
Valor de resposta genérico
- Body
- StringApiValue
Definições
ApiApproval
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
aprovador
|
approver | ApiUser |
Informação do utilizador |
|
aprovaçãoStepTime
|
approvalStepTime | date-time |
Tempo de atribuição ao aprovador atual». |
|
aprovaçãoEstado
|
approvalState | ApprovalState |
Estado do documento |
|
delegadoTo
|
delegatedTo | ApiUser |
Informação do utilizador |
|
Observação
|
note | string |
Nota do aprovador |
ApiApprovalReminder
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
Informação do utilizador |
|
paraUtilizador
|
toUser | ApiUser |
Informação do utilizador |
|
Tempo enviado
|
sentTime | date-time |
Hora de envio |
|
Observação
|
note | string |
Nota de urgência |
ApiDocument
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
ID do documento |
|
externalDocumentId
|
externalDocumentId | string |
ID do documento externo |
|
folderId
|
folderId | string |
ID do contêiner do documento |
|
contentHash
|
contentHash | string |
Hash do conteúdo |
|
pageCount
|
pageCount | integer |
Número total de páginas no documento, o primeiro índice é 1. Esse número pode não ser igual ao número de páginas, porque se o documento tiver muitas páginas, algumas delas podem ser ignoradas devido a motivos de desempenho |
|
fileName
|
fileName | string |
Nome do ficheiro do documento |
|
proprietário
|
owner | ApiUser |
Informação do utilizador |
|
state
|
state | DocumentState |
Estado do documento |
|
erro
|
error | string |
Código de erro do documento |
|
isImagesGenerated
|
isImagesGenerated | boolean |
Foram geradas imagens |
|
isDevolvido
|
isReturned | boolean |
True se os documentos foram devolvidos ao remetente. |
|
returnReason
|
returnReason | string |
Motivo da devolução. |
|
tempo de criação
|
creationTime | date-time |
Data de criação |
|
size
|
size | integer |
Tamanho do documento em KB |
|
TipoDeConteúdo
|
contentType | string |
Tipo de conteúdo |
|
origem
|
source | DocumentSource | |
|
fonteInformação
|
sourceInfo | string |
Detalhes da fonte (no endereço de e-mail geral) |
|
extractionTime
|
extractionTime | date-time |
Data de classificação |
|
modelo
|
model | string |
Tipo deste documento |
|
isAttachment
|
isAttachment | boolean |
Indica se o documento é um anexo |
|
isValidated
|
isValidated | boolean |
Indicador se o documento foi validado |
|
isEditado
|
isEdited | boolean |
Indicador, se este documento tiver sido editado (pelo menos um campo, nota ou etiqueta foi alterado) |
|
Observação
|
note | string |
Nota de utilizador personalizada |
|
campos
|
fields | object |
Lista de campos extraídos |
|
items
|
items | array of object |
Lista de produtos extraídos |
|
items
|
items | object | |
|
pages
|
pages | array of ApiPage |
Lista de todas as páginas que fazem parte de uma extração. |
|
pluginResultados
|
pluginResults | array of ApiPluginResult |
Resultados gerais |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
Indicador, se o pós-processamento tiver sido concluído |
|
isPré-validado
|
isPrevalidated | boolean |
Se um documento tem ou não alguns scripts pp de pré-validação |
|
lastOpenTime
|
lastOpenTime | date-time |
Data da última abertura |
|
lastOpenUserId
|
lastOpenUserId | string |
ID do utilizador que abriu este documento pela última vez |
|
isLocked
|
isLocked | boolean |
Determina se o documento está bloqueado ou não |
|
validationTime
|
validationTime | date-time |
O tempo em que o documento foi validado |
|
versão
|
version | integer |
Número da versão, incrementado a cada atualização |
|
aprovaçãoEstado
|
approvalState | ApprovalState |
Estado do documento |
|
currentApproverId
|
currentApproverId | string |
ID do utilizador que tem de aprovar este documento |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
Tempo de atribuição ao aprovador atual |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
A notificação foi enviada ao aprovador atual |
|
aprovaçãoHistórico
|
approvalHistory | array of ApiApproval |
Histórico de aprovação |
|
aprovaçãoLembreteHistórico
|
approvalReminderHistory | array of ApiApprovalReminder |
Histórico de aprovação |
|
authorizedUserIds
|
authorizedUserIds | array of string |
Utilizadores autorizados a aceder ao documento |
|
duplicadoDocIds
|
duplicateDocIds | array of string |
IDs de documento duplicados (com base em valores de campos) |
|
aprovadopor:
|
approvedBy | ApiUser |
Informação do utilizador |
|
validadoPor
|
validatedBy | ApiUser |
Informação do utilizador |
ApiDocumentApiListResult
Resultado da pesquisa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
lista
|
list | array of ApiDocument |
Lista de todos os valores encontrados |
|
temMais
|
hasMore | boolean |
True se a pesquisa puder retornar mais valores |
|
offset
|
offset | integer |
Valor de deslocamento (Número de valores ignorados) |
ApiEnum
Dados de enum para o tipo de campo enum
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador Enum |
|
nome
|
name | string |
Nome enum amigável |
|
values
|
values | object |
Lista de valores de enum |
|
isEditable
|
isEditable | boolean |
Indica se o enum pode ser editado |
ApiFolderCreationResult
Resultado da criação de contêineres
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID do contêiner |
ApiFolderWithMembros
Metadados do contêiner com metadados de documentos dentro do contêiner
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID do documento. |
|
ownerId
|
ownerId | string |
ID do proprietário do contêiner |
|
criado
|
created | date-time |
Tempo de criação do contentor |
|
metadados
|
metadata | object |
Todos os cabeçalhos anexados ao contêiner |
|
Membros
|
members | array of ApiDocument |
Lista de todos os membros do contêiner |
ApiItemCell
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
value | string |
Valor da célula |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
Indica se esse valor foi modificado pelo pós-processamento |
|
pluginResultados
|
pluginResults | array of ApiPluginResult |
Resultados de plugins |
ApiItemColumn
Define a coluna da tabela de itens.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
campo
|
field | string |
Campo |
|
Largura
|
width | double |
Altura da linha. |
ApiItemRow
Define a linha da tabela de itens.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
altura
|
height | double |
Altura da linha. |
|
células
|
cells | array of ApiItemCell |
Lista de todas as células nesta coluna. A contagem deve ser sempre igual ao número de colunas. |
ApiItemTable
Tabela de itens
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
Índice da página à qual a tabela pertence. |
|
offset
|
offset | Offset |
Define deslocamento bidimensional com coordenadas X e Y. |
|
columns
|
columns | array of ApiItemColumn |
Lista de definições de coluna. |
|
linhas
|
rows | array of ApiItemRow |
Lista de definições de linha e células em cada linha. |
ApiPage
Página do documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
indexar
|
index | integer |
Índice da página do documento. Indexado a partir de 1. |
|
Largura
|
width | integer |
Largura da página em pixels. |
|
altura
|
height | integer |
Altura da página em pixels. |
|
rotação
|
rotation | double |
Rotação da página em graus. |
|
words
|
words | array of ApiWord |
Lista de todas as palavras presentes na página. |
|
itemTabela
|
itemTable | ApiItemTable |
Tabela de itens |
ApiPluginResult
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pluginName
|
pluginName | string |
Obtém ou define o nome do script que validou este documento |
|
Código de resultados
|
resultCode | PostProcessResult |
Resultado do pós-processamento |
|
valor
|
value | string |
Obtém ou define a coleção de mensagens localizadas |
|
extraInformationRequired
|
extraInformationRequired | boolean |
Obtém ou define se são necessárias informações adicionais |
|
extraInformationMessage
|
extraInformationMessage | string |
Obtém ou define a mensagem de requisitos de informações extras |
ApiUploadResponse
Resultado do carregamento de um ficheiro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
ID do documento |
|
folderId
|
folderId | string |
ID da pasta |
ApiUser
Informação do utilizador
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID do utilizador |
|
primeiroNome
|
firstName | string |
Nome próprio do utilizador |
|
sobrenome
|
lastName | string |
Apelido do utilizador |
|
e-mail
|
string |
E-mail do usuário |
ApiUserApiListResult
Resultado da pesquisa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
lista
|
list | array of ApiUser |
Lista de todos os valores encontrados |
|
temMais
|
hasMore | boolean |
True se a pesquisa puder retornar mais valores |
|
offset
|
offset | integer |
Valor de deslocamento (Número de valores ignorados) |
ApiWord
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
wordId
|
wordId | integer |
Id da palavra, exclusivo para um documento |
|
pageIndex
|
pageIndex | integer |
Índice da página em que a palavra é apresentada |
|
enviar SMS
|
text | string |
Texto da palavra |
|
locX
|
locX | integer |
Coordenada X da palavra |
|
locY
|
locY | integer |
Coordenada Y da palavra |
|
Largura
|
width | integer |
Largura da palavra |
|
altura
|
height | integer |
Altura da palavra |
Estado de aprovação
Fonte do documento
Estado do Documento
LicenseTimePeriod
MLicense
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
responseCode
|
responseCode | ResponseCode | |
|
respostaMensagem
|
responseMessage | string | |
|
validDe
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
próximoPeríodo
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usoLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
Período de tempo para licenças |
|
isTrial
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
Compensação
Define deslocamento bidimensional com coordenadas X e Y.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
x
|
x | double |
Deslocamento na coordenada X. |
|
y
|
y | double |
Deslocamento na coordenada Y. |
PostProcessResult
RedQueStatus
Dados de resposta de status. Usado como resposta quando a solicitação não retorna dados.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado |
|
mensagem
|
message | string |
Message |
Código de resposta
StringApiValue
Valor de resposta genérico
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
value | string |
Valor |