9A Armazém de documentos Raptor
O 9A Raptor Document Warehouse é uma poderosa solução SaaS que traz estrutura e coerência às informações espalhadas por vários aplicativos de negócios. Esta solução oferece uma forma unificada e segura de aceder, gerir e procurar documentos.
Ao aproveitar a API do Raptor, você pode automatizar perfeitamente seus processos de gerenciamento de documentos. Execute várias ações, como carregar, baixar, marcar e organizar documentos.
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 | 9altitudes |
| URL | https://www.9altitudes.com |
| support@9altitudes.com |
| Metadados do conector | |
|---|---|
| Editora | 9altitudes |
| Sítio Web | https://9altitudes.com |
| Política de privacidade | https://www.9altitudes.com/privacy-policy |
| Categorias | Conteúdos e Ficheiros; Produtividade |
Conector de armazém de documentos Raptor 9A
Visão geral
O conector 9A Raptor Document Warehouse para Power Apps permite que você se integre perfeitamente com a plataforma 9A Raptor Document Warehouse, uma solução inteligente que consolida e gerencia informações em vários aplicativos de negócios, como PLM, ERP, CRM e muito mais. Este conector permite-lhe simplificar os seus processos de gestão de documentos ligando e gerindo documentos em diferentes entidades e sistemas, tudo a partir do Power Apps.
O que é o 9A Raptor Document Warehouse?
O 9A Raptor Document Warehouse é uma ferramenta poderosa que traz estrutura e coerência às informações espalhadas por vários aplicativos de negócios. Quer se trate de documentos do Dynamics 365, Teams ou aplicações personalizadas da Power Platform, esta solução fornece uma forma unificada e segura de aceder, gerir e procurar documentos. Garante que pode encontrar documentos relevantes ligados a qualquer entidade, independentemente do local onde foram inicialmente criados ou armazenados.
Os principais recursos do 9A Raptor Document Warehouse incluem:
- Gerenciamento consolidado de documentos: gerencie documentos em vários aplicativos, como PLM, ERP, CRM e muito mais.
- Segurança Context-Based dinâmica: certifique-se de que os documentos são acessíveis apenas às pessoas certas com base no contexto e nas regras de segurança.
- Integração entre sistemas: vincule documentos em diferentes sistemas de negócios, fornecendo uma única fonte de verdade.
- Recursos de pesquisa avançada: pesquise e filtre documentos usando várias dimensões, locais e atributos.
Pontos de extremidade da API
O conector 9A Raptor Document Warehouse fornece um conjunto abrangente de pontos de extremidade de API para interagir com a plataforma. Abaixo está uma lista de operações disponíveis:
Gestão de Utilizadores
- GetUserToken: Recupere um token de usuário para autenticar solicitações de API, usando um sistema externo.
- GetUserById: Recupere os detalhes do usuário por sua ID.
- QueryUsers: pesquise usuários com base em critérios específicos.
Gestão Documental
- DownloadDocument: Descarregue um documento pelo seu ID.
- UploadDocument: Carregue um documento.
- RemoveTagFromDocument: remova uma marca de um documento.
- TagDocument: adicione uma tag a um documento.
- AddFieldToDocument: Adicione um campo a um documento.
- UpdateFieldOnDocument: atualize um campo específico em um documento.
- AddTemplateToDocument: Adicione um modelo a um documento.
- QueryDocuments: pesquise documentos usando critérios específicos.
- AdvancedSearchQueryDocuments: Execute uma consulta de pesquisa avançada de documentos.
- InsertExternalFile: Carregue um arquivo externo para o depósito de documentos.
- GetDocumentMetadata: Recuperar metadados de um documento.
- GetDocumentMetadataByFileReference: Obtenha metadados do documento por referência de arquivo.
- DeleteDocument: exclua um documento por sua ID.
Gestão de Tags
- GetTagByTagId: Recupere uma tag por sua ID.
- GetTagByCode: Recupere uma tag por seu código.
- GetMultipleTags: Recupere várias tags com base em critérios.
- QueryTags: Pesquise tags usando critérios específicos.
Gestão de Campo
- CreateField: crie um novo campo para documentos.
- GetFieldById: Recupere um campo por sua ID.
- GetFieldByCode: Recupere um campo pelo seu código.
- GetTemplateFields: Recupere todos os campos associados a um modelo.
Gerenciamento de modelos
- GetTemplateById: Recupere um modelo por sua ID.
- GetTemplateByCode: Recupere um modelo por seu código.
- QueryTemplates: pesquise modelos usando critérios específicos.
Gerenciamento de armazenamento
- AddSiteToStorageProvider: adicione um site a um provedor de armazenamento.
- GetStorageProviderById: recupere um provedor de armazenamento por sua ID.
- SetPrimaryStorageProviderOfDocument: defina o provedor de armazenamento principal de um documento.
- SetExternalSource: defina a fonte externa de um documento.
- GenerateSiteSubscription: Gere uma assinatura para um site.
- FindDocument: localize um documento externo.
- DetachDocument: Desanexe um documento externo.
Integração de Sistemas
- GetExternalSystemById: Recupere detalhes de um sistema externo por sua ID.
- ResolveContext: resolva uma tag com base no contexto de negócios.
Introdução
Para começar a usar o conector 9A Raptor Document Warehouse em suas soluções Power Apps, basta adicionar o conector ao seu aplicativo, autenticar com suas credenciais de sistema externo e começar a usar as ações e gatilhos disponíveis para gerenciar documentos, usuários, tags, campos, modelos e muito mais.
Conclusion
O conector 9A Raptor Document Warehouse para Power Apps permite-lhe gerir eficientemente documentos e entidades relacionadas em vários sistemas empresariais, garantindo fluxos de trabalho suaves e maior produtividade. Com poderosas capacidades de pesquisa e segurança dinâmica baseada no contexto, pode garantir que os seus documentos estão sempre acessíveis e seguros.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar campo ao documento |
Adicionar um campo a um documento |
| Adicionar modelo ao documento |
Adicionar um modelo a um documento |
| Adicionar site ao provedor de armazenamento |
Adicionar um site do SharePoint a um provedor de armazenamento |
| Campo de atualização no documento |
Atualizar um campo que está em um documento |
| Carregar documento |
Carregar um documento para o Raptor Document Warehouse |
| Consultar documentos |
Consultar todos os documentos |
| Consultar usuários |
Consultar todos os utilizadores |
| Criar campo |
Criar um novo campo |
| Definir fonte externa |
Definir fonte externa para filereference |
| Definir provedor de armazenamento principal para documentos |
Definir o providor de armazenamento principal para um documento |
| Desanexar documento |
Mover arquivo do SharePoint para o armazenamento do Raptor |
| Descarregar documento |
Descarregar um documento pelo seu id |
| Documento de etiqueta |
Adicionar uma etiqueta a um documento utilizando um ID de documento e um ID de etiqueta |
| Eliminar documento |
Excluir documento por sua ID |
| Gerar subscrições de site |
Gerar uma assinatura para um site ad-hoc |
| Inserir ficheiro externo |
Inserir url de arquivo externo como documento |
| Modelos de consulta |
Consultar todos os modelos |
| Obter campo por código |
Obter um campo pelo seu código |
| Obter campo por ID |
Obter um campo pelo ID do campo |
| Obter campos de modelo |
Obter todos os campos de um modelo |
| Obter etiqueta por ID |
Recuperar uma tag usando o ID |
| Obter metadados do documento |
Obter metadados do documento usando a ID do documento |
| Obter metadados do documento por referência de arquivo |
Obter metadados do documento por um ID de referência de arquivo |
| Obter modelo por código |
Obter um modelo pelo código do modelo |
| Obter modelo por ID |
Obter um modelo pelo seu ID |
| Obter ou criar uma etiqueta |
Cria uma tag ou a recupera se existir uma tag com um código correspondente. |
| Obter provedor de armazenamento por ID |
Obter provedor de armazenamento usando o ID do provedor de armazenamento |
| Obter sistema externo por ID |
Obter um sistema externo pelo ID do sistema externo |
| Obter tag por código |
Obter tag pelo seu código |
| Obter token de usuário |
Solicitar um token de usuário para usar em suas ações |
| Obter usuário por id |
Obter um utilizador pelo seu ID |
| Obter várias tags |
Obter várias seleções de tags |
| Pesquisa avançada |
Pesquisar documentos usando uma consulta de pesquisa avançada |
| Procurar documento |
Localizar documento com ID de unidade do SharePoint e ID de item de unidade |
| Remover etiqueta do documento |
Remover uma etiqueta de um documento utilizando um ID de documento e um ID de etiqueta |
| Resolver contexto |
Resolve uma tag usando a configuração da entidade |
| Tags de consulta |
Consultar todas as tags |
Adicionar campo ao documento
Adicionar um campo a um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Método de ação
|
method | string |
Método a ser usado ao chamar a api |
|
|
Id
|
id | string |
id |
|
|
Valor
|
value | string |
valor |
Adicionar modelo ao documento
Adicionar um modelo a um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do modelo
|
templateId | True | string |
ID do modelo |
|
body
|
body | True | array of string |
Adicionar site ao provedor de armazenamento
Adicionar um site do SharePoint a um provedor de armazenamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Id
|
id | True | string |
Id |
|
caminho
|
path | string |
caminho |
|
|
tagContexto
|
tagContext | array of string |
tagContexto |
Campo de atualização no documento
Atualizar um campo que está em um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do documento
|
documentId | True | string |
ID do documento |
|
id
|
id | string |
id |
|
|
valor
|
value | string |
valor |
Carregar documento
Carregar um documento para o Raptor Document Warehouse
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Nome
|
name | True | string |
Nome |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Conteúdo do ficheiro
|
body | True | binary |
Conteúdo binário do documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
campos
|
fields | array of object |
campos |
|
id
|
fields.id | string |
id |
|
valor
|
fields.value | string |
valor |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
nome
|
name | string |
nome |
|
uploadCarimbo de data/hora
|
uploadTimestamp | string |
uploadCarimbo de data/hora |
Consultar documentos
Consultar todos os documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
obrigatórioTags
|
obligatoryTags | array of string |
obrigatórioTags |
|
|
tagsInHierarchy
|
tagsInHierarchy | array of string |
tagsInHierarchy |
|
|
fieldQueryExpression
|
fieldQueryExpression | object |
fieldQueryExpression |
|
|
excludeTagsInHierarchy
|
excludeTagsInHierarchy | array of string |
excludeTagsInHierarchy |
|
|
incluirTotalCount
|
includeTotalCount | boolean |
incluirTotalCount |
|
|
nome
|
name | string |
nome |
|
|
contémNome
|
containsName | string |
contémNome |
|
|
ordenarPor
|
orderBy | integer |
0 = Nada, 1 = Nome, 2 = Tamanho, 3 = Tempo de carregamento |
|
|
ordemAscendente
|
orderAscending | boolean |
ordemAscendente |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Resultado |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
campos
|
result.fields | array of object |
campos |
|
id
|
result.fields.id | string |
id |
|
valor
|
result.fields.value | string |
valor |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
nome
|
result.fileReference.name | string |
nome |
|
extrato
|
result.fileReference.ext | string |
extrato |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
carregador
|
result.fileReference.uploader | string |
carregador |
|
criado
|
result.fileReference.created | string |
criado |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
versão
|
result.fileReference.version | integer |
versão |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
result.fileReference.streamAvailable | boolean |
streamDisponível |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
AlteradoPor
|
result.fileReference.changedBy | string |
AlteradoPor |
|
nome
|
result.name | string |
nome |
|
uploadCarimbo de data/hora
|
result.uploadTimestamp | string |
uploadCarimbo de data/hora |
|
total
|
total | string |
total |
Consultar usuários
Consultar todos os utilizadores
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
excludeActiveUsers
|
excludeActiveUsers | boolean |
excludeActiveUsers |
|
|
excludeInactiveUsers
|
excludeInactiveUsers | boolean |
excludeInactiveUsers |
|
|
excludeNormalUsers
|
excludeNormalUsers | boolean |
excludeNormalUsers |
|
|
excludeSystemUsers
|
excludeSystemUsers | boolean |
excludeSystemUsers |
|
|
contémEmail
|
containsEmail | string |
contémEmail |
|
|
roleIds
|
roleIds | array of string |
roleIds |
|
|
nome
|
name | string |
nome |
|
|
contémNome
|
containsName | string |
contémNome |
|
|
ordemAscendente
|
orderAscending | boolean |
ordemAscendente |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Resultado |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
estado
|
result.status | integer |
estado |
|
nome de exibição
|
result.displayName | string |
nome de exibição |
|
primárioE-mail
|
result.primaryEmail | string |
primárioE-mail |
|
primeiroNome
|
result.firstName | string |
primeiroNome |
|
Apelido
|
result.surname | string |
Apelido |
|
cultura
|
result.culture | string |
cultura |
|
roles
|
result.roles | array of string |
roles |
|
isSystemUser
|
result.isSystemUser | boolean |
isSystemUser |
|
gestor
|
result.manager | string |
gestor |
|
total
|
total | integer |
total |
Criar campo
Criar um novo campo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Método de ação
|
method | string |
Método a ser usado ao chamar a api |
|
|
id
|
id | string |
id |
|
|
tenantId
|
tenantId | string |
tenantId |
|
|
código
|
code | string |
código |
|
|
Tipo de campo
|
fieldType | integer |
Tipo de campo |
|
|
é obrigatório
|
isRequired | boolean |
é obrigatório |
|
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
|
defaultValue
|
defaultValue | string |
defaultValue |
|
|
languageId
|
languageId | integer |
languageId |
|
|
valor
|
value | string |
valor |
|
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
|
languageId
|
languageId | integer |
languageId |
|
|
valor
|
value | string |
valor |
|
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
|
parentTagId
|
parentTagId | string |
parentTagId |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
Tipo de campo
|
fieldType | integer |
Tipo de campo |
|
é obrigatório
|
isRequired | boolean |
é obrigatório |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validaçãoMensagem
|
validationMessage | array of object |
validaçãoMensagem |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
valor
|
validationMessage.value | string |
valor |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Definir fonte externa
Definir fonte externa para filereference
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID de referência do arquivo
|
fileReferenceId | True | string |
ID da referência do ficheiro |
|
Body
|
body | True | string |
Body |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
nome
|
name | string |
nome |
|
extrato
|
ext | string |
extrato |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
carregador
|
uploader | string |
carregador |
|
criado
|
created | string |
criado |
|
mimeType
|
mimeType | string |
mimeType |
|
versão
|
version | integer |
versão |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
streamAvailable | boolean |
streamDisponível |
|
principalStorageProvider
|
primaryStorageProvider | string |
principalStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
AlteradoPor
|
changedBy | string |
AlteradoPor |
Definir provedor de armazenamento principal para documentos
Definir o providor de armazenamento principal para um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID de referência do arquivo
|
fileReferenceId | True | string |
ID da referência do ficheiro |
|
ID do provedor de armazenamento
|
storageProviderId | True | string |
ID do provedor de armazenamento |
|
Remover Raptor Storage
|
removeRaptorStorage | boolean |
Remover armazenamento Raptor |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
nome
|
name | string |
nome |
|
extrato
|
ext | string |
extrato |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
carregador
|
uploader | string |
carregador |
|
criado
|
created | string |
criado |
|
mimeType
|
mimeType | string |
mimeType |
|
versão
|
version | integer |
versão |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
streamAvailable | boolean |
streamDisponível |
|
principalStorageProvider
|
primaryStorageProvider | string |
principalStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
AlteradoPor
|
changedBy | string |
AlteradoPor |
Desanexar documento
Mover arquivo do SharePoint para o armazenamento do Raptor
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
azureDirectoryId
|
azureDirectoryId | string |
azureDirectoryId |
|
|
driveId
|
driveId | string |
driveId |
|
|
driveItemId
|
driveItemId | string |
driveItemId |
Descarregar documento
Descarregar um documento pelo seu id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Id
|
id | True | string |
ID do documento |
Devoluções
Documento descarregado
- Conteúdo do documento
- object
Documento de etiqueta
Adicionar uma etiqueta a um documento utilizando um ID de documento e um ID de etiqueta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do documento
|
documentId | True | string |
ID do documento |
|
ID da etiqueta
|
tagId | True | string |
ID da etiqueta |
|
Remarcar
|
reTag | boolean |
Devemos marcar novamente o documento |
Eliminar documento
Excluir documento por sua ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Id
|
id | True | string |
Id |
Gerar subscrições de site
Gerar uma assinatura para um site ad-hoc
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do provedor de armazenamento
|
storageProviderId | True | string |
ID do provedor de armazenamento |
|
Tipo de conteúdo
|
Content-Type | string |
Tipo de conteúdo |
|
|
Body
|
body | True | string |
Body |
Inserir ficheiro externo
Inserir url de arquivo externo como documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Nome do ficheiro
|
filename | True | string |
Nome do ficheiro |
|
body
|
body | string |
body |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of |
tags |
|
campos
|
fields | array of |
campos |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nome
|
name | string |
nome |
|
uploadCarimbo de data/hora
|
uploadTimestamp | string |
uploadCarimbo de data/hora |
Modelos de consulta
Consultar todos os modelos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
languageCode
|
languageCode | integer |
languageCode |
|
|
contextTags
|
contextTags | array of string |
contextTags |
|
|
ordenarPor
|
orderBy | integer |
ordenarPor |
|
|
nome
|
name | string |
nome |
|
|
contémNome
|
containsName | string |
contémNome |
|
|
ordemAscendente
|
orderAscending | boolean |
ordemAscendente |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Resultado |
|
id
|
result.id | string |
id |
|
nome
|
result.name | string |
nome |
|
tenantId
|
result.tenantId | string |
tenantId |
|
código
|
result.code | string |
código |
|
labels
|
result.labels | array of object |
labels |
|
languageId
|
result.labels.languageId | integer |
languageId |
|
valor
|
result.labels.value | string |
valor |
|
campos
|
result.fields | array of string |
campos |
|
Crianças
|
result.children | array of object |
Crianças |
|
id
|
result.children.id | string |
id |
|
tenantId
|
result.children.tenantId | string |
tenantId |
|
masterTemplateId
|
result.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
result.children.templateId | string |
templateId |
|
é obrigatório
|
result.children.isRequired | boolean |
é obrigatório |
|
modelo
|
result.children.template | string |
modelo |
|
relacionadoTags
|
result.relatedTags | array of string |
relacionadoTags |
|
contextTags
|
result.contextTags | array of string |
contextTags |
|
número de sequência
|
result.sequenceNumber | integer |
número de sequência |
|
adicionalProp1
|
result.additionalProp1 | string |
adicionalProp1 |
|
adicionalProp2
|
result.additionalProp2 | string |
adicionalProp2 |
|
adicionalProp3
|
result.additionalProp3 | string |
adicionalProp3 |
|
continuationToken
|
continuationToken | string |
continuationToken |
|
total
|
total | integer |
total |
Obter campo por código
Obter um campo pelo seu código
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Código
|
code | True | string |
Código da etiqueta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
Tipo de campo
|
fieldType | integer |
Tipo de campo |
|
é obrigatório
|
isRequired | boolean |
é obrigatório |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validaçãoMensagem
|
validationMessage | array of object |
validaçãoMensagem |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
valor
|
validationMessage.value | string |
valor |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter campo por ID
Obter um campo pelo ID do campo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do campo
|
fieldId | True | string |
ID do campo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
Tipo de campo
|
fieldType | integer |
Tipo de campo |
|
é obrigatório
|
isRequired | boolean |
é obrigatório |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validaçãoMensagem
|
validationMessage | array of object |
validaçãoMensagem |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
valor
|
validationMessage.value | string |
valor |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter campos de modelo
Obter todos os campos de um modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do modelo
|
templateId | True | string |
ID do modelo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
Tipo de campo
|
fieldType | integer |
Tipo de campo |
|
é obrigatório
|
isRequired | boolean |
é obrigatório |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validaçãoMensagem
|
validationMessage | array of object |
validaçãoMensagem |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
valor
|
validationMessage.value | string |
valor |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter etiqueta por ID
Recuperar uma tag usando o ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID da etiqueta
|
tagId | True | string |
ID da etiqueta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
tagRelações
|
tagRelations | array of string |
tagRelações |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
origem
|
syncDetails.source | string |
origem |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Obter metadados do documento
Obter metadados do documento usando a ID do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Id
|
id | True | string |
Id |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
campos
|
fields | array of |
campos |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileId
|
fileReference.fileId | string |
fileId |
|
nome
|
fileReference.name | string |
nome |
|
extrato
|
fileReference.ext | string |
extrato |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
carregador
|
fileReference.uploader | string |
carregador |
|
criado
|
fileReference.created | string |
criado |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
versão
|
fileReference.version | integer |
versão |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
fileReference.streamAvailable | boolean |
streamDisponível |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
AlteradoPor
|
fileReference.changedBy | string |
AlteradoPor |
|
nome
|
name | string |
nome |
|
uploadCarimbo de data/hora
|
uploadTimestamp | string |
uploadCarimbo de data/hora |
Obter metadados do documento por referência de arquivo
Obter metadados do documento por um ID de referência de arquivo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID de referência do arquivo
|
fileReferenceId | True | string |
ID da referência do ficheiro |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
campos
|
fields | array of |
campos |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nome
|
name | string |
nome |
|
uploadCarimbo de data/hora
|
uploadTimestamp | string |
uploadCarimbo de data/hora |
Obter modelo por código
Obter um modelo pelo código do modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Código
|
code | True | string |
Código da etiqueta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
campos
|
fields | array of string |
campos |
|
Crianças
|
children | array of object |
Crianças |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
é obrigatório
|
children.isRequired | boolean |
é obrigatório |
|
id
|
children.template.id | string |
id |
|
nome
|
children.template.name | string |
nome |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
código
|
children.template.code | string |
código |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
valor
|
children.template.labels.value | string |
valor |
|
campos
|
children.template.fields | array of string |
campos |
|
Crianças
|
children.template.children | array of object |
Crianças |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.template.children.templateId | string |
templateId |
|
é obrigatório
|
children.template.children.isRequired | boolean |
é obrigatório |
|
relacionadoTags
|
children.template.relatedTags | array of string |
relacionadoTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
número de sequência
|
children.template.sequenceNumber | integer |
número de sequência |
|
relacionadoTags
|
relatedTags | array of string |
relacionadoTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
número de sequência
|
sequenceNumber | integer |
número de sequência |
Obter modelo por ID
Obter um modelo pelo seu ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do modelo
|
templateId | True | string |
ID do modelo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
campos
|
fields | array of string |
campos |
|
Crianças
|
children | array of object |
Crianças |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
é obrigatório
|
children.isRequired | boolean |
é obrigatório |
|
id
|
children.template.id | string |
id |
|
nome
|
children.template.name | string |
nome |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
código
|
children.template.code | string |
código |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
valor
|
children.template.labels.value | string |
valor |
|
campos
|
children.template.fields | array of string |
campos |
|
Crianças
|
children.template.children | array of object |
Crianças |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.template.children.templateId | string |
templateId |
|
é obrigatório
|
children.template.children.isRequired | boolean |
é obrigatório |
|
relacionadoTags
|
children.template.relatedTags | array of string |
relacionadoTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
número de sequência
|
children.template.sequenceNumber | integer |
número de sequência |
|
relacionadoTags
|
relatedTags | array of string |
relacionadoTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
número de sequência
|
sequenceNumber | integer |
número de sequência |
Obter ou criar uma etiqueta
Cria uma tag ou a recupera se existir uma tag com um código correspondente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
método
|
method | True | string |
método |
|
código
|
code | string |
código |
|
|
languageId
|
languageId | integer |
languageId |
|
|
valor
|
value | string |
Valor do rótulo |
|
|
parentTagId
|
parentTagId | string |
Id da tag pai |
Obter provedor de armazenamento por ID
Obter provedor de armazenamento usando o ID do provedor de armazenamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Id
|
id | True | string |
Id |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
baseUri
|
baseUri | string |
baseUri |
|
configurações do site
|
siteConfigurations | array of object |
configurações do site |
|
id
|
siteConfigurations.id | string |
id |
|
caminho
|
siteConfigurations.path | string |
caminho |
|
tagContexto
|
siteConfigurations.tagContext | array of string |
tagContexto |
|
isActive
|
isActive | boolean |
isActive |
|
directoryId
|
directoryId | string |
directoryId |
|
lastSubscriptionExpiryCheck
|
lastSubscriptionExpiryCheck | string |
lastSubscriptionExpiryCheck |
Obter sistema externo por ID
Obter um sistema externo pelo ID do sistema externo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do sistema externo
|
externalSystemId | True | string |
ID do sistema externo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
nome
|
name | string |
nome |
|
hasUserUI
|
hasUserUI | boolean |
hasUserUI |
Obter tag por código
Obter tag pelo seu código
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Código
|
code | True | string |
Código da etiqueta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
tagRelações
|
tagRelations | array of string |
tagRelações |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
origem
|
syncDetails.source | string |
origem |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Obter token de usuário
Solicitar um token de usuário para usar em suas ações
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do sistema externo
|
externalSystemID | True | string |
Id do sistema externo |
|
Segredo
|
secret | True | string |
Segredo do sistema externo |
|
Nome de usuário externo
|
externalUserName | True | string |
Nome de usuário usado para o sistema externo |
Devoluções
Token para autenticar em um locatário do Raptor
- Símbolo
- string
Obter usuário por id
Obter um utilizador pelo seu ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do Utilizador
|
userId | True | string |
ID do utilizador |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
estado
|
status | integer |
estado |
|
nome de exibição
|
displayName | string |
nome de exibição |
|
primárioE-mail
|
primaryEmail | string |
primárioE-mail |
|
primeiroNome
|
firstName | string |
primeiroNome |
|
Apelido
|
surname | string |
Apelido |
|
cultura
|
culture | string |
cultura |
|
roles
|
roles | array of string |
roles |
|
isSystemUser
|
isSystemUser | boolean |
isSystemUser |
|
gestor
|
manager | string |
gestor |
Obter várias tags
Obter várias seleções de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
identificadores
|
ids | array of string |
Matriz de IDs de tag |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
tagRelações
|
tagRelations | array of string |
tagRelações |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
origem
|
syncDetails.source | string |
origem |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Pesquisa avançada
Pesquisar documentos usando uma consulta de pesquisa avançada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
|
object |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Resultado |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
campos
|
result.fields | array of object |
campos |
|
id
|
result.fields.id | string |
id |
|
nome
|
result.fields.name | string |
nome |
|
valor
|
result.fields.value | string |
valor |
|
númeroValor
|
result.fields.numberValue | integer |
númeroValor |
|
é obrigatório
|
result.fields.isRequired | boolean |
é obrigatório |
|
Tipo de campo
|
result.fields.fieldType | integer |
Tipo de campo |
|
users
|
result.fields.users | array of |
users |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
fileId
|
result.fileReference.fileId | string |
fileId |
|
nome
|
result.fileReference.name | string |
nome |
|
extrato
|
result.fileReference.ext | string |
extrato |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
carregador
|
result.fileReference.uploader | string |
carregador |
|
criado
|
result.fileReference.created | string |
criado |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
versão
|
result.fileReference.version | integer |
versão |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
result.fileReference.streamAvailable | boolean |
streamDisponível |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
AlteradoPor
|
result.fileReference.changedBy | string |
AlteradoPor |
|
nome
|
result.name | string |
nome |
|
uploadCarimbo de data/hora
|
result.uploadTimestamp | string |
uploadCarimbo de data/hora |
|
total
|
total | string |
total |
Procurar documento
Localizar documento com ID de unidade do SharePoint e ID de item de unidade
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do Diretório do Azure
|
azureDirectoryId | True | string |
ID do diretório do Azure |
|
ID da unidade
|
driveId | True | string |
ID da unidade |
|
ID do item da unidade
|
driveItemId | True | string |
ID do item da unidade |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
campos
|
fields | array of object |
campos |
|
id
|
fields.id | string |
id |
|
nome
|
fields.name | string |
nome |
|
valor
|
fields.value | string |
valor |
|
númeroValor
|
fields.numberValue | string |
númeroValor |
|
é obrigatório
|
fields.isRequired | boolean |
é obrigatório |
|
Tipo de campo
|
fields.fieldType | integer |
Tipo de campo |
|
users
|
fields.users | array of |
users |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileId
|
fileReference.fileId | string |
fileId |
|
nome
|
fileReference.name | string |
nome |
|
extrato
|
fileReference.ext | string |
extrato |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
carregador
|
fileReference.uploader | string |
carregador |
|
criado
|
fileReference.created | string |
criado |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
versão
|
fileReference.version | integer |
versão |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamDisponível
|
fileReference.streamAvailable | boolean |
streamDisponível |
|
principalStorageProvider
|
fileReference.primaryStorageProvider | string |
principalStorageProvider |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
AlteradoPor
|
fileReference.changedBy | string |
AlteradoPor |
|
nome
|
name | string |
nome |
|
uploadCarimbo de data/hora
|
uploadTimestamp | string |
uploadCarimbo de data/hora |
Remover etiqueta do documento
Remover uma etiqueta de um documento utilizando um ID de documento e um ID de etiqueta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID do documento
|
documentId | True | string |
ID do documento |
|
ID da etiqueta
|
tagId | True | string |
ID da etiqueta |
Resolver contexto
Resolve uma tag usando a configuração da entidade
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
origem
|
source | string |
origem |
|
|
entityName
|
entityName | string |
entityName |
|
|
legalEntity
|
legalEntity | string |
legalEntity |
|
|
campos
|
fields | string |
campos |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
valor
|
labels.value | string |
valor |
|
tagRelações
|
tagRelations | array of string |
tagRelações |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
origem
|
syncDetails.source | string |
origem |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Tags de consulta
Consultar todas as tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
|
directParentTagId
|
directParentTagId | string |
directParentTagId |
|
|
hasNoParentTag
|
hasNoParentTag | boolean |
hasNoParentTag |
|
|
incluirTotalCount
|
includeTotalCount | boolean |
incluirTotalCount |
|
|
nome
|
name | string |
nome |
|
|
contémNome
|
containsName | string |
contémNome |
|
|
ordemAscendente
|
orderAscending | boolean |
ordemAscendente |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Resultado |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
providerId
|
result.providerId | string |
providerId |
|
parentTagId
|
result.parentTagId | string |
parentTagId |
|
parentHierarchy
|
result.parentHierarchy | array of string |
parentHierarchy |
|
labels
|
result.labels | array of object |
labels |
|
languageId
|
result.labels.languageId | integer |
languageId |
|
valor
|
result.labels.value | string |
valor |
|
tagRelações
|
result.tagRelations | array of string |
tagRelações |
|
código
|
result.code | string |
código |
|
externalEntityName
|
result.syncDetails.externalEntityName | string |
externalEntityName |
|
origem
|
result.syncDetails.source | string |
origem |
|
primaryIdFields
|
result.syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
result.syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
result.syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
result.syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
result.excludeFromSearch | boolean |
excludeFromSearch |
|
total
|
total | integer |
total |
Definições
objecto
Este é o tipo 'objeto'.
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.