Redque (versão prévia)
Acessando e gerenciando o sistema Redque.
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 | Redque s.r.o. |
| URL | https://redque.com |
| info@redque.com |
| Metadados do conector | |
|---|---|
| Publicador | Redque s.r.o. |
| Site | https://redque.cz/en/ |
| Política de privacidade | https://redque.cz/policy.html |
| Categorias | IA; Financiar |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar permissões |
Adiciona permissões ao usuário. |
| Alterar a senha do usuário |
Altera a senha do usuário especificado. Requer permissão de gerenciamento de usuário. |
| Alterar senha |
Altera a senha do usuário. |
| Atualizar dados de pasta |
Atualiza os dados da pasta. |
| Atualizar documento |
Atualiza o documento. |
| Atualizar enumeração específica |
Atualiza uma enumeração específica. |
| Atualizar o retorno à configuração do remetente |
As atualizações retornam à configuração do remetente. |
| Atualizar usuário |
Atualiza parcialmente um usuário especificado. |
| Baixar o arquivo do documento |
Baixa o arquivo do documento. |
| Baixar pasta |
Baixa todos os documentos em uma pasta como um único arquivo morto. |
| Bloquear documento |
Bloqueia (abre) o documento impedindo que outros usuários o modifiquem. |
| Carregar um documento e agende-o para processamento |
Carrega o documento e o agenda para processamento. |
| Conceder acesso de documento ao usuário especificado |
Concede acesso de documento ao usuário especificado. |
| Criar nova enumeração |
Observe que a chave de enumeração é gerada automaticamente e as chaves de valor devem conter apenas letras minúsculas, letras maiúsculas, números, sublinhado, traço |
| Criar uma pasta |
Cria uma nova pasta. |
| Criar usuário |
Cria um novo usuário. |
| Desbloquear documento bloqueado |
Desbloqueia o documento bloqueado (fecha) para permitir que outros usuários modifiquem seu conteúdo. |
| Enumeração de retorno |
Retorna enumeração específica. |
| Exclui enumeração com id específica |
Exclui uma enumeração específica. |
| Excluir usuário |
Exclui um usuário. |
| Extrair documento |
Solicita a extração de um documento. Depois que o documento for recuperado, ele será agendado para exclusão. |
| Filtrar documentos |
Retorna a lista de documentos com base em parâmetros. |
| Filtrar usuários |
Obtém a lista de usuários por critérios. |
| Gerar token |
Gera um 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. |
| Localizar usuário |
Localiza um usuário. |
| Obter documento extraído |
O documento extraído está 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 novamente recuperar o resultado se eles falharem. |
| Obter metadados do documento |
Obtém os metadados do documento. |
| Remove o 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 documento ao emissor para correções |
Retorna o documento ao emissor para correções para o endereço de email fornecido. |
| Retornar todas as enumerações |
Retorna a lista de todas as enumerações. |
| 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
|
permissões
|
permissions | array of string |
Acessar dados |
Alterar a senha do usuário
Altera a senha do usuário especificado. Requer permissão de gerenciamento de usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
|
senha
|
password | string |
Senha do usuário |
|
|
ID da conta
|
accountId | string |
ID da conta do usuário |
|
|
chave de ativação
|
activationkey | string |
Chave de ativação do usuário |
Alterar senha
Altera a senha do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
|
body
|
body | string |
Senha do usuário |
Atualizar dados de pasta
Atualiza os dados da pasta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
ID da pasta |
|
folderId
|
folderId | string |
ID do documento. |
|
|
ID do proprietário
|
ownerId | string |
ID do proprietário do contêiner |
|
|
criadas
|
created | date-time |
Hora da criação do contêiner |
|
|
metadados
|
metadata | object |
Todos os cabeçalhos anexados ao contêiner |
Atualizar documento
Atualiza o documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
documentId
|
documentId | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
value
|
value | boolean | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
operação
|
operation | string | ||
|
chave
|
key | string | ||
|
mensagem
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
value
|
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 | ||
|
estado
|
state | string |
Estado do documento |
|
|
value
|
value | string | ||
|
operação
|
operation | string | ||
|
value
|
value | string | ||
|
operação
|
operation | string |
Retornos
Dados de resposta de status. Usado como resposta quando a solicitação não retorna dados.
- Corpo
- RedQueStatus
Atualizar enumeração específica
Atualiza uma enumeração específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de enumeração
|
id | True | string |
Identificador de enumeração |
|
id
|
id | string |
Identificador de enumeração |
|
|
nome
|
name | string |
Nome da enumeração amigável |
|
|
values
|
values | object |
Lista de valores de enumeração |
|
|
isEditable
|
isEditable | boolean |
Indica se a enumeração pode ser editada |
Atualizar o retorno à configuração do remetente
As atualizações retornam à configuração do remetente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
modelo
|
template | string | ||
|
assunto
|
subject | string |
Atualizar usuário
Atualiza parcialmente um usuário especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
|
primeiro nome
|
firstName | string |
Nome do usuário |
|
|
sobrenome
|
lastName | string |
Sobrenome do usuário |
Baixar o arquivo do documento
Baixa o arquivo do documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Identificador de documento |
Baixar pasta
Baixa todos os documentos em uma pasta como um único arquivo morto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador de pasta |
Bloquear documento
Bloqueia (abre) o documento impedindo que outros usuários o modifiquem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Carregar um documento e agende-o para processamento
Carrega o documento e o agenda para processamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
File
|
File | file |
File |
|
|
ID externa do documento
|
DocumentId | string |
ID do documento externo |
|
|
ID da pasta
|
FolderId | string |
ID da pasta |
|
|
Date
|
Date | date-time |
Date |
|
|
Pedido
|
Ordinal | integer |
Ordem usada para manter a ordem dos documentos que são carregados em paralelo |
|
|
É documentar um anexo
|
IsAttachment | boolean |
True se o documento for um anexo |
|
|
Classe de documento
|
DocumentClass | string |
Classe de documento |
Retornos
Resultado de um upload de arquivo
- Corpo
- ApiUploadResponse
Conceder acesso de documento ao usuário especificado
Concede acesso de documento ao usuário especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
ID do Usuário
|
userId | True | string |
ID do Usuário |
|
documentId
|
documentId | string |
ID do documento |
|
|
userId
|
userId | string |
ID do usuário |
|
|
mensagem
|
message | string |
Criar nova enumeração
Observe que a chave de enumeração é gerada automaticamente e as chaves de valor devem conter apenas letras minúsculas, letras maiúsculas, números, sublinhado, traço
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | string |
Identificador de enumeração |
|
|
nome
|
name | string |
Nome da enumeração amigável |
|
|
values
|
values | object |
Lista de valores de enumeração |
|
|
isEditable
|
isEditable | boolean |
Indica se a enumeração pode ser editada |
Retornos
Valor de resposta genérico
- Corpo
- StringApiValue
Criar uma pasta
Criar usuário
Cria um novo usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
primeiro nome
|
firstName | string |
Nome do usuário |
|
|
sobrenome
|
lastName | string |
Sobrenome do usuário |
|
|
senha
|
password | string |
Senha da conta |
|
|
email
|
string |
Email (nome de logon) do usuário |
Desbloquear documento bloqueado
Desbloqueia o documento bloqueado (fecha) para permitir que outros usuários modifiquem seu conteúdo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Enumeração de retorno
Retorna enumeração específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de enumeração
|
id | True | string |
Identificador de enumeração |
Retornos
Enumerar dados para enumeração de tipo de campo
- Corpo
- ApiEnum
Exclui enumeração com id específica
Exclui uma enumeração específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Enumeração de chave
|
id | True | string |
Identificador/chave de enumeração |
Excluir usuário
Exclui um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Identificação de usuário |
Extrair documento
Solicita a extração de um documento. Depois que o documento for recuperado, ele será agendado para exclusão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
externalDocumentId | string |
ID do documento (opcional – sua ID do documento externo) |
|
|
File
|
file | file |
File |
Filtrar documentos
Retorna a lista de documentos com base em parâmetros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
enviar SMS
|
text | string |
Texto de pesquisa usado para pesquisas gerais |
|
|
value
|
value | string | ||
|
values
|
values | string |
Estado do documento |
|
|
values
|
values | string |
Estado do documento |
|
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
from
|
from | date-time | ||
|
para
|
to | date-time | ||
|
fields
|
fields | object |
Filtros de campo |
|
|
ignorar
|
skip | integer |
Quantos itens ignorar do início da lista. Permite paginação. |
|
|
tomar
|
take | integer |
Número máximo de itens de lista que serão retornados |
|
|
campo
|
field | string |
Lista de propriedades nas quais os resultados podem ser classificados |
|
|
direção
|
direction | string |
Direção na qual os valores de lista são classificados |
|
|
escopos
|
scopes | string |
Escopo do documento que filtra quais partes do documento devem ser retornadas |
Retornos
Resultado da pesquisa
- Corpo
- ApiDocumentApiListResult
Filtrar usuários
Obtém a lista de usuários por critérios.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
enviar SMS
|
text | string |
Texto de pesquisa usado para pesquisas gerais |
|
|
value
|
value | string | ||
|
ignorar
|
skip | integer |
Quantos itens ignorar do início da lista. Permite paginação. |
|
|
tomar
|
take | integer |
Número máximo de itens de lista que serão retornados |
|
|
campo
|
field | string |
Enumeração para declarar parâmetros de classificação de usuário |
|
|
direção
|
direction | string |
Direção na qual os valores de lista são classificados |
Retornos
Resultado da pesquisa
- Corpo
- ApiUserApiListResult
Gerar token
Imagem para uma determinada página
Retorna uma imagem para uma determinada página.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Índice de página
|
pageIndex | True | integer |
Índice de página |
|
Preview
|
isPreview | boolean |
True se a imagem de tamanho reduzido deve ser retornada. |
Retornos
- response
- uri
Informações de licença
Localizar pasta
Localiza a pasta por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador de pasta |
|
Com membros
|
withMembers | boolean |
True se documento com membros |
Retornos
Metadados de contêiner com metadados de documentos dentro do contêiner
- Corpo
- ApiFolderWithMembers
Localizar usuário
Localiza um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
Retornos
Informações do usuário
- Corpo
- ApiUser
Obter documento extraído
O documento extraído está 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 novamente recuperar o resultado se eles falharem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento (fornecida pelo RedQue ou externo) |
Obter metadados do documento
Obtém os metadados do documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
A ID do documento é uma ID externa?
|
isExternalId | boolean |
A ID do documento é uma ID externa? |
Retornos
- Corpo
- ApiDocument
Remove o token
Remove o token de registro.
Remover documento existente
Remove o documento existente.
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Identificador de documento |
|
ID do Usuário
|
userId | True | string |
Identificador de usuário |
Remover pasta
Remove a pasta existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta
|
folderId | True | string |
Identificador de pasta |
Remover permissões
Revoga as permissões do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
|
permissões
|
permissions | array of string |
Acessar dados |
Retornar documento ao emissor para correções
Retorna o documento ao emissor para correções para o endereço de email fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
additionalDocuments
|
additionalDocuments | array of string | ||
|
recipientEmail
|
recipientEmail | string | ||
|
reason
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
Retornar todas as enumerações
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.
Retornos
Valor de resposta genérico
- Corpo
- StringApiValue
Definições
ApiApproval
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
aprovador
|
approver | ApiUser |
Informações do usuário |
|
approvalStepTime
|
approvalStepTime | date-time |
Tempo de atribuição para o aprovador atual'. |
|
approvalState
|
approvalState | ApprovalState |
Estado do documento |
|
delegatedTo
|
delegatedTo | ApiUser |
Informações do usuário |
|
nota
|
note | string |
Nota do aprovador |
ApiApprovalReminder
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
Informações do usuário |
|
toUser
|
toUser | ApiUser |
Informações do usuário |
|
sentTime
|
sentTime | date-time |
Hora do envio |
|
nota
|
note | string |
Observação de urgência |
ApiDocument
| Nome | 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, pois se o documento tiver muitas páginas, algumas delas poderão ser ignoradas por motivos de desempenho |
|
fileName
|
fileName | string |
Nome do arquivo do documento |
|
proprietário
|
owner | ApiUser |
Informações do usuário |
|
estado
|
state | DocumentState |
Estado do documento |
|
erro
|
error | string |
Código de erro do documento |
|
isImagesGenerated
|
isImagesGenerated | boolean |
Foram geradas imagens |
|
isReturned
|
isReturned | boolean |
True se os documentos foram retornados ao remetente. |
|
returnReason
|
returnReason | string |
Motivo do retorno. |
|
tempoDeCriação
|
creationTime | date-time |
Data de criação |
|
size
|
size | integer |
Tamanho do documento em KB |
|
tipo de conteúdo
|
contentType | string |
Tipo de conteúdo |
|
fonte
|
source | DocumentSource | |
|
sourceInfo
|
sourceInfo | string |
Detalhes da origem (em endereço de email geral) |
|
extractionTime
|
extractionTime | date-time |
Data de classificação |
|
modelo
|
model | string |
Tipo deste documento |
|
isAttachment
|
isAttachment | boolean |
Indica se o documento é um anexo |
|
é validado
|
isValidated | boolean |
Indicador se o documento foi validado |
|
isEdited
|
isEdited | boolean |
Indicador, se este documento tiver sido editado (pelo menos um campo, anotação ou marca foi alterado) |
|
nota
|
note | string |
Observação personalizada do usuário |
|
fields
|
fields | object |
Lista de campos extraídos |
|
items
|
items | array of object |
Lista de itens extraídos |
|
items
|
items | object | |
|
Páginas
|
pages | array of ApiPage |
Lista de todas as páginas que fazem parte de uma extração. |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Resultados gerais |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
Indicador, se o processamento pós-processamento tiver sido concluído |
|
isPrevalidated
|
isPrevalidated | boolean |
Se um documento tem ou não alguns scripts pp de pré-avaliação |
|
lastOpenTime
|
lastOpenTime | date-time |
Última data de abertura |
|
lastOpenUserId
|
lastOpenUserId | string |
ID do usuário que abriu este documento pela última vez |
|
isLocked
|
isLocked | boolean |
Determina se o documento está bloqueado ou não |
|
validationTime
|
validationTime | date-time |
A hora em que o documento foi validado |
|
versão
|
version | integer |
Número de versão, incrementado a cada atualização |
|
approvalState
|
approvalState | ApprovalState |
Estado do documento |
|
currentApproverId
|
currentApproverId | string |
Id do usuário que precisa aprovar este documento |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
Tempo de atribuição para o aprovador atual |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
A notificação foi enviada ao aprovador atual |
|
approvalHistory
|
approvalHistory | array of ApiApproval |
Histórico de aprovação |
|
approvalReminderHistory
|
approvalReminderHistory | array of ApiApprovalReminder |
Aprovar histórico |
|
authorizedUserIds
|
authorizedUserIds | array of string |
Usuários autorizados a acessar o documento |
|
duplicateDocIds
|
duplicateDocIds | array of string |
IDs de documento duplicadas (com base em valores de campos) |
|
approvedBy
|
approvedBy | ApiUser |
Informações do usuário |
|
validatedBy
|
validatedBy | ApiUser |
Informações do usuário |
ApiDocumentApiListResult
Resultado da pesquisa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lista
|
list | array of ApiDocument |
Lista de todos os valores encontrados |
|
hasMore
|
hasMore | boolean |
True se a pesquisa puder retornar mais valores |
|
deslocamento
|
offset | integer |
Valor de deslocamento (número de valores ignorados) |
ApiEnum
Enumerar dados para enumeração de tipo de campo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de enumeração |
|
nome
|
name | string |
Nome da enumeração amigável |
|
values
|
values | object |
Lista de valores de enumeração |
|
isEditable
|
isEditable | boolean |
Indica se a enumeração pode ser editada |
ApiFolderCreationResult
Resultado da criação do contêiner
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID do contêiner |
ApiFolderWithMembers
Metadados de contêiner com metadados de documentos dentro do contêiner
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID do documento. |
|
ID do proprietário
|
ownerId | string |
ID do proprietário do contêiner |
|
criadas
|
created | date-time |
Hora da criação do contêiner |
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | string |
Valor da célula |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
Indica se esse valor foi modificado após o processamento |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Resultados de plug-ins |
ApiItemColumn
Define a coluna da tabela de itens.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
campo
|
field | string |
Campo |
|
largura
|
width | double |
Altura da linha. |
ApiItemRow
Define a linha da tabela de itens.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
height
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
Índice da página à qual a tabela pertence. |
|
deslocamento
|
offset | Offset |
Define o 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 Documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
indexar
|
index | integer |
Índice de página do documento. Indexado a partir de 1. |
|
largura
|
width | integer |
Largura da página em pixels. |
|
height
|
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. |
|
itemTable
|
itemTable | ApiItemTable |
Tabela de itens |
ApiPluginResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
pluginName
|
pluginName | string |
Obtém ou define o nome do script que validou este documento |
|
resultCode
|
resultCode | PostProcessResult |
Resultado do pós-processamento |
|
value
|
value | string |
Obtém ou define a coleção de mensagens localizadas |
|
extraInformationRequired
|
extraInformationRequired | boolean |
Obtém ou define se informações extras são necessárias |
|
extraInformationMessage
|
extraInformationMessage | string |
Obtém ou define a mensagem de requisitos de informações extras |
ApiUploadResponse
Resultado de um upload de arquivo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
ID do documento |
|
folderId
|
folderId | string |
ID da pasta |
ApiUser
Informações do usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID do usuário |
|
primeiro nome
|
firstName | string |
Nome do usuário |
|
sobrenome
|
lastName | string |
Sobrenome do usuário |
|
email
|
string |
Email do usuário |
ApiUserApiListResult
Resultado da pesquisa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lista
|
list | array of ApiUser |
Lista de todos os valores encontrados |
|
hasMore
|
hasMore | boolean |
True se a pesquisa puder retornar mais valores |
|
deslocamento
|
offset | integer |
Valor de deslocamento (número de valores ignorados) |
ApiWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
wordId
|
wordId | integer |
ID da palavra, exclusiva 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 do Word |
|
height
|
height | integer |
Altura do Word |
ApprovalState
DocumentSource
DocumentState
LicenseTimePeriod
MLicense
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de resposta
|
responseCode | ResponseCode | |
|
responseMessage
|
responseMessage | string | |
|
validFrom
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
nextPeriod
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usageLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
Período de tempo para licenças |
|
isTrial
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
Offset
Define o deslocamento bidimensional com coordenadas X e Y.
| Nome | 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.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de status
|
statusCode | integer |
Código de status |
|
mensagem
|
message | string |
Message |
Código de Resposta
StringApiValue
Valor de resposta genérico
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | string |
Value |