9A Raptor Document Warehouse
O 9A Raptor Document Warehouse é uma solução SaaS poderosa que traz estrutura e coerência para informações espalhadas por vários aplicativos de negócios. Essa solução oferece uma maneira unificada e segura de acessar, gerenciar e pesquisar documentos.
Aproveitando a API Raptor, você pode automatizar perfeitamente os processos de gerenciamento de documentos. Execute várias ações, como carregar, baixar, marcar e organizar documentos.
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 | 9altitudes |
| URL | https://www.9altitudes.com |
| support@9altitudes.com |
| Metadados do conector | |
|---|---|
| Publicador | 9altitudes |
| Site da Web | https://9altitudes.com |
| Política de privacidade | https://www.9altitudes.com/privacy-policy |
| Categorias | Conteúdo e arquivos; Produtividade |
Conector do 9A Raptor Document Warehouse
Visão geral
O conector do 9A Raptor Document Warehouse para Power Apps permite que você se integre perfeitamente à plataforma 9A Raptor Document Warehouse, uma solução inteligente que consolida e gerencia informações em vários aplicativos empresariais, como PLM, ERP, CRM e muito mais. Esse conector permite que você simplifique seus processos de gerenciamento de documentos vinculando e gerenciando documentos entre diferentes entidades e sistemas, tudo de dentro do Power Apps.
O que é o 9A Raptor Document Warehouse?
O 9A Raptor Document Warehouse é uma ferramenta poderosa que traz estrutura e coerência para informações distribuídas em vários aplicativos empresariais. Seja documentos do Dynamics 365, teams ou aplicativos personalizados do Power Platform, essa solução fornece uma maneira unificada e segura de acessar, gerenciar e pesquisar documentos. Ele garante que você possa encontrar documentos relevantes vinculados a qualquer entidade, independentemente de onde eles foram inicialmente criados ou armazenados.
Os principais recursos do 9A Raptor Document Warehouse incluem:
- Gerenciamento consolidado de documentos: gerenciar documentos em vários aplicativos, como PLM, ERP, CRM e muito mais.
- Segurança de Context-Based dinâmica: verifique se os documentos são acessíveis apenas para as pessoas certas com base em regras de contexto e segurança.
- Integração entre sistemas: vincule documentos em diferentes sistemas de negócios, fornecendo uma única fonte de verdade.
- Recursos avançados de pesquisa: pesquise e filtre documentos usando várias dimensões, locais e atributos.
Pontos de extremidade de API
O conector do 9A Raptor Document Warehouse fornece um conjunto abrangente de pontos de extremidade de API para interagir com a plataforma. Veja abaixo uma lista de operações disponíveis:
Gerenciamento de Usuários
- GetUserToken: recupere um token de usuário para autenticar solicitações de API usando um sistema externo.
- GetUserById: recuperar os detalhes do usuário por sua ID.
- QueryUsers: pesquise usuários com base em critérios específicos.
Gerenciamento de documentos
- DownloadDocument: baixe um documento por sua ID.
- UploadDocument: carregar um documento.
- RemoveTagFromDocument: remova uma marca de um documento.
- TagDocument: adicione uma marca 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 para documentos.
- InsertExternalFile: carregue um arquivo externo no armazém de documentos.
- GetDocumentMetadata: recuperar metadados de um documento.
- GetDocumentMetadataByFileReference: obter metadados de documento por referência de arquivo.
- DeleteDocument: exclua um documento por sua ID.
Gerenciamento de marcas
- GetTagByTagId: recuperar uma marca por sua ID.
- GetTagByCode: recuperar uma marca por seu código.
- GetMultipleTags: recuperar várias marcas com base em critérios.
- QueryTags: pesquise marcas usando critérios específicos.
Gerenciamento de Campos
- CreateField: criar um novo campo para documentos.
- GetFieldById: recuperar um campo por sua ID.
- GetFieldByCode: recuperar um campo por seu código.
- GetTemplateFields: recuperar todos os campos associados a um modelo.
Gerenciamento de modelos
- GetTemplateById: recuperar um modelo por sua ID.
- GetTemplateByCode: recuperar 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: recuperar um provedor de armazenamento por sua ID.
- SetPrimaryStorageProviderOfDocument: defina o provedor de armazenamento primário de um documento.
- SetExternalSource: defina a origem externa de um documento.
- GenerateSiteSubscription: gerar uma assinatura para um site.
- FindDocument: localizar um documento externo.
- DetachDocument: desanexe um documento externo.
Integração do sistema
- GetExternalSystemById: recuperar detalhes de um sistema externo por sua ID.
- ResolveContext: resolva uma marca com base no contexto de negócios.
Introdução
Para começar a usar o conector do 9A Raptor Document Warehouse em suas soluções do 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, marcas, campos, modelos e muito mais.
Conclusion
O conector do 9A Raptor Document Warehouse para Power Apps permite que você gerencie com eficiência documentos e entidades relacionadas em vários sistemas de negócios, garantindo fluxos de trabalho suaves e produtividade aprimorada. Com recursos de pesquisa avançados e segurança dinâmica baseada em contexto, você pode garantir que seus documentos estejam sempre acessíveis e seguros.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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 |
| Atualizar campo no documento |
Atualizar um campo que está em um documento |
| Baixar documento |
Baixar um documento por sua ID |
| Carregar documento |
Carregar um documento no Raptor Document Warehouse |
| Consultar documentos |
Consultar todos os documentos |
| Consultar usuários |
Consultar todos os usuários |
| Criar campo |
Criar um novo campo |
| Definir o provedor de armazenamento primário para documento |
Definir o providor de armazenamento primário para um documento |
| Definir origem externa |
Definir fonte externa para filereference |
| Desanexar documento |
Mover o arquivo do SharePoint para o armazenamento raptor |
| Excluir documento |
Excluir documento por sua ID |
| Gerar assinaturas de site |
Gerar uma assinatura para um site ad-hoc |
| Inserir arquivo externo |
Inserir url do arquivo externo como documento |
| Localizar documento |
Localizar documento com a ID da unidade do SharePoint e a ID do item de unidade |
| Marcar documento |
Adicionar uma marca a um documento usando uma ID de documento e uma ID de marca |
| Marcas de consulta |
Consultar todas as marcas |
| Modelos de consulta |
Consultar todos os modelos |
| Obter campo por código |
Obter um campo por seu código |
| Obter campo por ID |
Obter um campo pela ID do campo |
| Obter campos de modelo |
Obter todos os campos de um modelo |
| Obter marca por código |
Obter marca pelo código |
| Obter marca por ID |
Recuperar uma marca usando a ID |
| Obter metadados de documento por referência de arquivo |
Obter metadados de documento por uma ID de referência de arquivo |
| Obter metadados do documento |
Obter metadados de documento usando a ID do documento |
| Obter modelo por código |
Obter um modelo pelo código do modelo |
| Obter modelo por ID |
Obter um modelo por sua ID |
| Obter o provedor de armazenamento por ID |
Obter o provedor de armazenamento usando a ID do provedor de armazenamento |
| Obter ou criar uma marca |
Cria uma marca ou a recupera se existir uma marca com um código correspondente. |
| Obter sistema externo por ID |
Obter um sistema externo pela ID do sistema externo |
| Obter token de usuário |
Solicitar um token de usuário para usar em suas ações |
| Obter usuário por ID |
Obter um usuário por sua ID |
| Obter várias marcas |
Obter várias seleções de marcas |
| Pesquisa avançada |
Pesquisar documentos usando uma consulta de pesquisa avançada |
| Remover marca do documento |
Remover uma marca de um documento usando uma ID de documento e uma ID de marca |
| Resolver o contexto |
Resolve uma marca usando a configuração da entidade |
Adicionar campo ao documento
Adicionar um campo a um documento
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
Value
|
value | string |
value |
Adicionar modelo ao documento
Adicionar um modelo a um documento
Parâmetros
| Nome | Chave | Obrigató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
| Nome | Chave | Obrigató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 |
|
|
tagContext
|
tagContext | array of string |
tagContext |
Atualizar campo no documento
Atualizar um campo que está em um documento
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
value
|
value | string |
value |
Baixar documento
Baixar um documento por sua ID
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
Documento baixado
- Conteúdo do Documento
- object
Carregar documento
Carregar um documento no Raptor Document Warehouse
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
fields
|
fields | array of object |
fields |
|
id
|
fields.id | string |
id |
|
value
|
fields.value | string |
value |
|
id do modelo
|
templateId | string |
id do modelo |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
nome
|
name | string |
nome |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Consultar documentos
Consultar todos os documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
obligatoryTags
|
obligatoryTags | array of string |
obligatoryTags |
|
|
tagsInHierarchy
|
tagsInHierarchy | array of string |
tagsInHierarchy |
|
|
fieldQueryExpression
|
fieldQueryExpression | object |
fieldQueryExpression |
|
|
excludeTagsInHierarchy
|
excludeTagsInHierarchy | array of string |
excludeTagsInHierarchy |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
nome
|
name | string |
nome |
|
|
containsName
|
containsName | string |
containsName |
|
|
ordenarPor
|
orderBy | integer |
0 = Nothing, 1 = Name, 2 = Size, 3 = Upload time |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
fields
|
result.fields | array of object |
fields |
|
id
|
result.fields.id | string |
id |
|
value
|
result.fields.value | string |
value |
|
id do modelo
|
result.templateId | string |
id do modelo |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
nome
|
result.fileReference.name | string |
nome |
|
Ext
|
result.fileReference.ext | string |
Ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
carregador
|
result.fileReference.uploader | string |
carregador |
|
criadas
|
result.fileReference.created | string |
criadas |
|
Tipo MIME
|
result.fileReference.mimeType | string |
Tipo MIME |
|
versão
|
result.fileReference.version | integer |
versão |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
result.fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
changedBy
|
result.fileReference.changedBy | string |
changedBy |
|
nome
|
result.name | string |
nome |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Consultar usuários
Consultar todos os usuários
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
containsEmail
|
containsEmail | string |
containsEmail |
|
|
roleIds
|
roleIds | array of string |
roleIds |
|
|
nome
|
name | string |
nome |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
status
|
result.status | integer |
status |
|
nome de exibição
|
result.displayName | string |
nome de exibição |
|
primaryEmail
|
result.primaryEmail | string |
primaryEmail |
|
primeiro nome
|
result.firstName | string |
primeiro nome |
|
surname
|
result.surname | string |
surname |
|
cultura
|
result.culture | string |
cultura |
|
funções
|
result.roles | array of string |
funções |
|
isSystemUser
|
result.isSystemUser | boolean |
isSystemUser |
|
gerente
|
result.manager | string |
gerente |
|
total
|
total | integer |
total |
Criar campo
Criar um novo campo
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
codificar
|
code | string |
codificar |
|
|
tipo de campo
|
fieldType | integer |
tipo de campo |
|
|
IsRequired
|
isRequired | boolean |
IsRequired |
|
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
|
defaultValue
|
defaultValue | string |
defaultValue |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
|
parentTagId
|
parentTagId | string |
parentTagId |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
tipo de campo
|
fieldType | integer |
tipo de campo |
|
IsRequired
|
isRequired | boolean |
IsRequired |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Definir o provedor de armazenamento primário para documento
Definir o providor de armazenamento primário para um documento
Parâmetros
| Nome | Chave | Obrigató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 de arquivo
|
fileReferenceId | True | string |
ID da referência de arquivo |
|
ID do provedor de armazenamento
|
storageProviderId | True | string |
ID do provedor de armazenamento |
|
Remover o armazenamento do Raptor
|
removeRaptorStorage | boolean |
Remover armazenamento do Raptor |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
nome
|
name | string |
nome |
|
Ext
|
ext | string |
Ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
carregador
|
uploader | string |
carregador |
|
criadas
|
created | string |
criadas |
|
Tipo MIME
|
mimeType | string |
Tipo MIME |
|
versão
|
version | integer |
versão |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Definir origem externa
Definir fonte externa para filereference
Parâmetros
| Nome | Chave | Obrigató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 de arquivo
|
fileReferenceId | True | string |
ID da referência de arquivo |
|
Corpo
|
body | True | string |
Corpo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
nome
|
name | string |
nome |
|
Ext
|
ext | string |
Ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
carregador
|
uploader | string |
carregador |
|
criadas
|
created | string |
criadas |
|
Tipo MIME
|
mimeType | string |
Tipo MIME |
|
versão
|
version | integer |
versão |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Desanexar documento
Mover o arquivo do SharePoint para o armazenamento raptor
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
ID da unidade
|
driveId | string |
ID da unidade |
|
|
driveItemId
|
driveItemId | string |
driveItemId |
Excluir documento
Excluir documento por sua ID
Parâmetros
| Nome | Chave | Obrigató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 assinaturas de site
Gerar uma assinatura para um site ad-hoc
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
Corpo
|
body | True | string |
Corpo |
Inserir arquivo externo
Inserir url do arquivo externo como documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Nome do Arquivo
|
filename | True | string |
Nome do Arquivo |
|
body
|
body | string |
body |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of |
tags |
|
fields
|
fields | array of |
fields |
|
id do modelo
|
templateId | string |
id do modelo |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nome
|
name | string |
nome |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Localizar documento
Localizar documento com a ID da unidade do SharePoint e a ID do item de unidade
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
fields
|
fields | array of object |
fields |
|
id
|
fields.id | string |
id |
|
nome
|
fields.name | string |
nome |
|
value
|
fields.value | string |
value |
|
numberValue
|
fields.numberValue | string |
numberValue |
|
IsRequired
|
fields.isRequired | boolean |
IsRequired |
|
tipo de campo
|
fields.fieldType | integer |
tipo de campo |
|
users
|
fields.users | array of |
users |
|
id do modelo
|
templateId | string |
id do modelo |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileId
|
fileReference.fileId | string |
fileId |
|
nome
|
fileReference.name | string |
nome |
|
Ext
|
fileReference.ext | string |
Ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
carregador
|
fileReference.uploader | string |
carregador |
|
criadas
|
fileReference.created | string |
criadas |
|
Tipo MIME
|
fileReference.mimeType | string |
Tipo MIME |
|
versão
|
fileReference.version | integer |
versão |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
fileReference.streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
fileReference.primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
changedBy
|
fileReference.changedBy | string |
changedBy |
|
nome
|
name | string |
nome |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Marcar documento
Adicionar uma marca a um documento usando uma ID de documento e uma ID de marca
Parâmetros
| Nome | Chave | Obrigató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 marca
|
tagId | True | string |
ID da marca |
|
Retag
|
reTag | boolean |
Devemos retag do documento |
Marcas de consulta
Consultar todas as marcas
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
nome
|
name | string |
nome |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
ID do provedor
|
result.providerId | string |
ID do provedor |
|
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 |
|
value
|
result.labels.value | string |
value |
|
tagRelations
|
result.tagRelations | array of string |
tagRelations |
|
codificar
|
result.code | string |
codificar |
|
externalEntityName
|
result.syncDetails.externalEntityName | string |
externalEntityName |
|
fonte
|
result.syncDetails.source | string |
fonte |
|
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 |
Modelos de consulta
Consultar todos os modelos
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
id
|
result.id | string |
id |
|
nome
|
result.name | string |
nome |
|
tenantId
|
result.tenantId | string |
tenantId |
|
codificar
|
result.code | string |
codificar |
|
labels
|
result.labels | array of object |
labels |
|
languageId
|
result.labels.languageId | integer |
languageId |
|
value
|
result.labels.value | string |
value |
|
fields
|
result.fields | array of string |
fields |
|
children
|
result.children | array of object |
children |
|
id
|
result.children.id | string |
id |
|
tenantId
|
result.children.tenantId | string |
tenantId |
|
masterTemplateId
|
result.children.masterTemplateId | string |
masterTemplateId |
|
id do modelo
|
result.children.templateId | string |
id do modelo |
|
IsRequired
|
result.children.isRequired | boolean |
IsRequired |
|
modelo
|
result.children.template | string |
modelo |
|
relatedTags
|
result.relatedTags | array of string |
relatedTags |
|
contextTags
|
result.contextTags | array of string |
contextTags |
|
sequenceNumber
|
result.sequenceNumber | integer |
sequenceNumber |
|
additionalProp1
|
result.additionalProp1 | string |
additionalProp1 |
|
additionalProp2
|
result.additionalProp2 | string |
additionalProp2 |
|
additionalProp3
|
result.additionalProp3 | string |
additionalProp3 |
|
continuationToken
|
continuationToken | string |
continuationToken |
|
total
|
total | integer |
total |
Obter campo por código
Obter um campo por seu código
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Code
|
code | True | string |
Código de marcação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
tipo de campo
|
fieldType | integer |
tipo de campo |
|
IsRequired
|
isRequired | boolean |
IsRequired |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter campo por ID
Obter um campo pela ID do campo
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
tipo de campo
|
fieldType | integer |
tipo de campo |
|
IsRequired
|
isRequired | boolean |
IsRequired |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter campos de modelo
Obter todos os campos de um modelo
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
tipo de campo
|
fieldType | integer |
tipo de campo |
|
IsRequired
|
isRequired | boolean |
IsRequired |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validandoRegExp
|
validatingRegExp | string |
validandoRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obter marca por código
Obter marca pelo código
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Code
|
code | True | string |
Código de marcação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
ID do provedor
|
providerId | string |
ID do provedor |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
codificar
|
code | string |
codificar |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
fonte
|
syncDetails.source | string |
fonte |
|
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 marca por ID
Recuperar uma marca usando a ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ID da marca
|
tagId | True | string |
ID da marca |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
ID do provedor
|
providerId | string |
ID do provedor |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
codificar
|
code | string |
codificar |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
fonte
|
syncDetails.source | string |
fonte |
|
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 de documento por referência de arquivo
Obter metadados de documento por uma ID de referência de arquivo
Parâmetros
| Nome | Chave | Obrigató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 de arquivo
|
fileReferenceId | True | string |
ID da referência de arquivo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
id do modelo
|
templateId | string |
id do modelo |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nome
|
name | string |
nome |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Obter metadados do documento
Obter metadados de documento usando a ID do documento
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
id do modelo
|
templateId | string |
id do modelo |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileId
|
fileReference.fileId | string |
fileId |
|
nome
|
fileReference.name | string |
nome |
|
Ext
|
fileReference.ext | string |
Ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
carregador
|
fileReference.uploader | string |
carregador |
|
criadas
|
fileReference.created | string |
criadas |
|
Tipo MIME
|
fileReference.mimeType | string |
Tipo MIME |
|
versão
|
fileReference.version | integer |
versão |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
changedBy
|
fileReference.changedBy | string |
changedBy |
|
nome
|
name | string |
nome |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Obter modelo por código
Obter um modelo pelo código do modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Code
|
code | True | string |
Código de marcação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
children
|
children | array of object |
children |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
id do modelo
|
children.templateId | string |
id do modelo |
|
IsRequired
|
children.isRequired | boolean |
IsRequired |
|
id
|
children.template.id | string |
id |
|
nome
|
children.template.name | string |
nome |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
codificar
|
children.template.code | string |
codificar |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
children
|
children.template.children | array of object |
children |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
id do modelo
|
children.template.children.templateId | string |
id do modelo |
|
IsRequired
|
children.template.children.isRequired | boolean |
IsRequired |
|
relatedTags
|
children.template.relatedTags | array of string |
relatedTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
sequenceNumber
|
children.template.sequenceNumber | integer |
sequenceNumber |
|
relatedTags
|
relatedTags | array of string |
relatedTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
sequenceNumber
|
sequenceNumber | integer |
sequenceNumber |
Obter modelo por ID
Obter um modelo por sua ID
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
tenantId
|
tenantId | string |
tenantId |
|
codificar
|
code | string |
codificar |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
children
|
children | array of object |
children |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
id do modelo
|
children.templateId | string |
id do modelo |
|
IsRequired
|
children.isRequired | boolean |
IsRequired |
|
id
|
children.template.id | string |
id |
|
nome
|
children.template.name | string |
nome |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
codificar
|
children.template.code | string |
codificar |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
children
|
children.template.children | array of object |
children |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
id do modelo
|
children.template.children.templateId | string |
id do modelo |
|
IsRequired
|
children.template.children.isRequired | boolean |
IsRequired |
|
relatedTags
|
children.template.relatedTags | array of string |
relatedTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
sequenceNumber
|
children.template.sequenceNumber | integer |
sequenceNumber |
|
relatedTags
|
relatedTags | array of string |
relatedTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
sequenceNumber
|
sequenceNumber | integer |
sequenceNumber |
Obter o provedor de armazenamento por ID
Obter o provedor de armazenamento usando a ID do provedor de armazenamento
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nome
|
name | string |
nome |
|
baseUri
|
baseUri | string |
baseUri |
|
siteConfigurations
|
siteConfigurations | array of object |
siteConfigurations |
|
id
|
siteConfigurations.id | string |
id |
|
caminho
|
siteConfigurations.path | string |
caminho |
|
tagContext
|
siteConfigurations.tagContext | array of string |
tagContext |
|
isActive
|
isActive | boolean |
isActive |
|
ID do diretório
|
directoryId | string |
ID do diretório |
|
lastSubscriptionExpiryCheck
|
lastSubscriptionExpiryCheck | string |
lastSubscriptionExpiryCheck |
Obter ou criar uma marca
Cria uma marca ou a recupera se existir uma marca com um código correspondente.
Parâmetros
| Nome | Chave | Obrigató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 |
|
codificar
|
code | string |
codificar |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
Valor do rótulo |
|
|
parentTagId
|
parentTagId | string |
ID da marca pai |
Obter sistema externo por ID
Obter um sistema externo pela ID do sistema externo
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
nome
|
name | string |
nome |
|
hasUserUI
|
hasUserUI | boolean |
hasUserUI |
Obter token de usuário
Solicitar um token de usuário para usar em suas ações
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do sistema externo
|
externalSystemID | True | string |
ID do sistema externo |
|
Secret
|
secret | True | string |
Segredo do sistema externo |
|
Nome de Usuário Externo
|
externalUserName | True | string |
Nome de usuário usado para o sistema externo |
Retornos
Token para autenticar em um locatário do Raptor
- Símbolo
- string
Obter usuário por ID
Obter um usuário por sua ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
Identificação de usuário
|
userId | True | string |
ID do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
status
|
status | integer |
status |
|
nome de exibição
|
displayName | string |
nome de exibição |
|
primaryEmail
|
primaryEmail | string |
primaryEmail |
|
primeiro nome
|
firstName | string |
primeiro nome |
|
surname
|
surname | string |
surname |
|
cultura
|
culture | string |
cultura |
|
funções
|
roles | array of string |
funções |
|
isSystemUser
|
isSystemUser | boolean |
isSystemUser |
|
gerente
|
manager | string |
gerente |
Obter várias marcas
Obter várias seleções de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
ids
|
ids | array of string |
Matriz de IDs de marca |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
ID do provedor
|
providerId | string |
ID do provedor |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
codificar
|
code | string |
codificar |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
fonte
|
syncDetails.source | string |
fonte |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
|
object |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
fields
|
result.fields | array of object |
fields |
|
id
|
result.fields.id | string |
id |
|
nome
|
result.fields.name | string |
nome |
|
value
|
result.fields.value | string |
value |
|
numberValue
|
result.fields.numberValue | integer |
numberValue |
|
IsRequired
|
result.fields.isRequired | boolean |
IsRequired |
|
tipo de campo
|
result.fields.fieldType | integer |
tipo de campo |
|
users
|
result.fields.users | array of |
users |
|
id do modelo
|
result.templateId | string |
id do modelo |
|
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 |
|
Ext
|
result.fileReference.ext | string |
Ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
carregador
|
result.fileReference.uploader | string |
carregador |
|
criadas
|
result.fileReference.created | string |
criadas |
|
Tipo MIME
|
result.fileReference.mimeType | string |
Tipo MIME |
|
versão
|
result.fileReference.version | integer |
versão |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
result.fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
changedBy
|
result.fileReference.changedBy | string |
changedBy |
|
nome
|
result.name | string |
nome |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Remover marca do documento
Remover uma marca de um documento usando uma ID de documento e uma ID de marca
Parâmetros
| Nome | Chave | Obrigató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 marca
|
tagId | True | string |
ID da marca |
Resolver o contexto
Resolve uma marca usando a configuração da entidade
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
exa-auth-plugin | True | string |
Token usado para autenticação (consulte 'Obter token de usuário') |
|
fonte
|
source | string |
fonte |
|
|
entityName
|
entityName | string |
entityName |
|
|
legalEntity
|
legalEntity | string |
legalEntity |
|
|
fields
|
fields | string |
fields |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
ID do provedor
|
providerId | string |
ID do provedor |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
codificar
|
code | string |
codificar |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
fonte
|
syncDetails.source | string |
fonte |
|
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 |
Definições
objeto
Esse é o tipo 'object'.
cadeia
Esse é o tipo de dados básico 'string'.