9A Raptor Almacén de Documentos
9A Raptor Document Warehouse es una eficaz solución SaaS que aporta estructura y coherencia a la información dispersa en diversas aplicaciones empresariales. Esta solución ofrece una manera unificada y segura de acceder, administrar y buscar documentos.
Al aprovechar la API de Raptor, puede automatizar sin problemas los procesos de administración de documentos. Realice varias acciones, como cargar, descargar, etiquetar y organizar documentos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | 9titudes |
| URL | https://www.9altitudes.com |
| Correo Electrónico | support@9altitudes.com |
| Metadatos del conector | |
|---|---|
| Publicador | 9titudes |
| Sitio web | https://9altitudes.com |
| Directiva de privacidad | https://www.9altitudes.com/privacy-policy |
| Categorías | Contenido y archivos; Productividad |
Conector 9A Raptor Document Warehouse
Información general
El conector 9A Raptor Document Warehouse para Power Apps le permite integrarse sin problemas con la plataforma 9A Raptor Document Warehouse, una solución inteligente que consolida y administra información en diversas aplicaciones empresariales, como PLM, ERP, CRM, etc. Este conector le permite simplificar los procesos de administración de documentos mediante la vinculación y administración de documentos en diferentes entidades y sistemas, todo ello desde Power Apps.
¿Qué es 9A Raptor Document Warehouse?
9A Raptor Document Warehouse es una herramienta eficaz que aporta estructura y coherencia a la información distribuida en varias aplicaciones empresariales. Ya sea documentos de aplicaciones de Dynamics 365, Teams o Power Platform personalizadas, esta solución proporciona una manera unificada y segura de acceder, administrar y buscar documentos. Garantiza que puede encontrar documentos relevantes vinculados a cualquier entidad, independientemente de dónde se crearon o almacenaron inicialmente.
Entre las características clave de 9A Raptor Document Warehouse se incluyen:
- Gestión consolidada de documentos: administre documentos en varias aplicaciones como PLM, ERP, CRM, etc.
- Seguridad de Context-Based dinámica: asegúrese de que los documentos solo sean accesibles para las personas adecuadas en función del contexto y las reglas de seguridad.
- Integración entre sistemas: vincule documentos en diferentes sistemas empresariales, lo que proporciona una única fuente de verdad.
- Funcionalidades avanzadas de búsqueda: buscar y filtrar documentos mediante varias dimensiones, ubicaciones y atributos.
Puntos de conexión de API
El conector 9A Raptor Document Warehouse proporciona un conjunto completo de puntos de conexión de API para interactuar con la plataforma. A continuación se muestra una lista de las operaciones disponibles:
Administración de usuarios
- GetUserToken: recupere un token de usuario para autenticar las solicitudes de API mediante un sistema externo.
- GetUserById: recupere los detalles del usuario por su identificador.
- QueryUsers: busque usuarios en función de criterios específicos.
Administrar documentos
- DownloadDocument: descargue un documento por su identificador.
- UploadDocument: cargue un documento.
- RemoveTagFromDocument: quite una etiqueta de un documento.
- TagDocument: agregue una etiqueta a un documento.
- AddFieldToDocument: agregue un campo a un documento.
- UpdateFieldOnDocument: actualice un campo específico en un documento.
- AddTemplateToDocument: agregue una plantilla a un documento.
- QueryDocuments: busque documentos con criterios específicos.
- AdvancedSearchQueryDocuments: realice una consulta de búsqueda avanzada para documentos.
- InsertExternalFile: cargue un archivo externo en el almacenamiento de documentos.
- GetDocumentMetadata: recupere metadatos de un documento.
- GetDocumentMetadataByFileReference: obtener metadatos de documento por referencia de archivo.
- DeleteDocument: elimine un documento por su identificador.
Administración de etiquetas
- GetTagByTagId: recupere una etiqueta por su identificador.
- GetTagByCode: recupere una etiqueta por su código.
- GetMultipleTags: recupere varias etiquetas basadas en criterios.
- QueryTags: busque etiquetas con criterios específicos.
Administración de campos
- CreateField: cree un nuevo campo para documentos.
- GetFieldById: recupere un campo por su identificador.
- GetFieldByCode: recupere un campo por su código.
- GetTemplateFields: recupere todos los campos asociados a una plantilla.
Administración de plantillas
- GetTemplateById: recupere una plantilla por su identificador.
- GetTemplateByCode: recupere una plantilla por su código.
- QueryTemplates: busque plantillas con criterios específicos.
Administración del almacenamiento
- AddSiteToStorageProvider: agregue un sitio a un proveedor de almacenamiento.
- GetStorageProviderById: recupere un proveedor de almacenamiento por su identificador.
- SetPrimaryStorageProviderOfDocument: establezca el proveedor de almacenamiento principal de un documento.
- SetExternalSource: establezca el origen externo de un documento.
- GenerateSiteSubscription: genere una suscripción a un sitio.
- FindDocument: busque un documento externo.
- DetachDocument: desasocie un documento externo.
Integración de sistemas
- GetExternalSystemById: recupera los detalles de un sistema externo por su identificador.
- ResolveContext: resuelva una etiqueta basada en el contexto empresarial.
Introducción
Para empezar a usar el conector 9A Raptor Document Warehouse en las soluciones de Power Apps, basta con agregar el conector a la aplicación, autenticarse con las credenciales del sistema externo y empezar a usar las acciones y desencadenadores disponibles para administrar documentos, usuarios, etiquetas, campos, plantillas, etc.
Conclusión
El conector 9A Raptor Document Warehouse para Power Apps le permite administrar de forma eficaz documentos y entidades relacionadas en varios sistemas empresariales, lo que garantiza flujos de trabajo suaves y una mayor productividad. Con eficaces funcionalidades de búsqueda y seguridad dinámica basada en contexto, puede asegurarse de que los documentos siempre son accesibles y seguros.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar campo en el documento |
Actualizar un campo que se encuentra en un documento |
| Agregar campo al documento |
Agregar un campo a un documento |
| Agregar plantilla al documento |
Agregar una plantilla a un documento |
| Agregar sitio al proveedor de almacenamiento |
Agregar un sitio de SharePoint a un proveedor de almacenamiento |
| Buscar documento |
Buscar documento con el identificador de unidad de SharePoint e identificador de elemento de unidad |
| Búsqueda avanzada |
Buscar documentos mediante una consulta de búsqueda avanzada |
| Cargar documento |
Cargar un documento en Raptor Document Warehouse |
| Consulta de usuarios |
Consulta a todos los usuarios |
| Consultar documentos |
Consulta de todos los documentos |
| Crear campo |
Crear un nuevo campo |
| Desasociar documento |
Mover el archivo de SharePoint al almacenamiento de Raptor |
| Descargar documento |
Descargar un documento por su identificador |
| Eliminar documento |
Eliminar documento por su identificador |
| Establecer origen externo |
Establecer el origen externo para filereference |
| Establecimiento del proveedor de almacenamiento principal para el documento |
Establecimiento del providor de almacenamiento principal para un documento |
| Etiquetar documento |
Agregar una etiqueta a un documento mediante un identificador de documento y un identificador de etiqueta |
| Etiquetas de búsqueda |
Consulta de todas las etiquetas |
| Generación de suscripciones de sitio |
Generación de una suscripción para un sitio ad hoc |
| Insertar archivo externo |
Insertar dirección URL del archivo externo como documento |
| Obtención de metadatos de documento |
Obtención de metadatos de documento mediante el identificador de documento |
| Obtención de metadatos de documento por referencia de archivo |
Obtención de metadatos de documento mediante un identificador de referencia de archivo |
| Obtención de varias etiquetas |
Obtener varias selecciones de etiquetas |
| Obtención del proveedor de almacenamiento por identificador |
Obtención del proveedor de almacenamiento mediante el identificador del proveedor de almacenamiento |
| Obtención del sistema externo por identificador |
Obtención de un sistema externo mediante el identificador de sistema externo |
| Obtención del token de usuario |
Solicitud de un token de usuario para usarlo en las acciones |
| Obtención del usuario por identificador |
Obtener un usuario por su identificador |
| Obtener campo por código |
Obtener un campo por su código |
| Obtener campo por identificador |
Obtener un campo por el identificador de campo |
| Obtener campos de plantilla |
Obtener todos los campos de una plantilla |
| Obtener etiqueta por código |
Obtener etiqueta por su código |
| Obtener etiqueta por identificador |
Recuperación de una etiqueta mediante el identificador |
| Obtener o crear una etiqueta |
Crea una etiqueta o la recupera si existe una etiqueta con un código coincidente. |
| Obtener plantilla por código |
Obtención de una plantilla mediante el código de plantilla |
| Obtener plantilla por identificador |
Obtención de una plantilla por su identificador |
| Plantillas de consulta |
Consulta de todas las plantillas |
| Quitar etiqueta del documento |
Quitar una etiqueta de un documento mediante un identificador de documento y un identificador de etiqueta |
| Resolución del contexto |
Resuelve una etiqueta mediante la configuración de entidad. |
Actualizar campo en el documento
Actualizar un campo que se encuentra en un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. de documento
|
documentId | True | string |
Identificador del documento |
|
id
|
id | string |
id |
|
|
value
|
value | string |
value |
Agregar campo al documento
Agregar un campo a un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. de documento
|
documentId | True | string |
Identificador del documento |
|
Método de acción
|
method | string |
Método que se va a usar al llamar a la API |
|
|
Id
|
id | string |
id |
|
|
Importancia
|
value | string |
value |
Agregar plantilla al documento
Agregar una plantilla a un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de plantilla
|
templateId | True | string |
Identificador de la plantilla |
|
body
|
body | True | array of string |
Agregar sitio al proveedor de almacenamiento
Agregar un sitio de SharePoint a un proveedor de almacenamiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id
|
id | True | string |
Id |
|
camino
|
path | string |
camino |
|
|
tagContext
|
tagContext | array of string |
tagContext |
Buscar documento
Buscar documento con el identificador de unidad de SharePoint e identificador de elemento de unidad
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de Directorio de Azure
|
azureDirectoryId | True | string |
Identificador de directorio de Azure |
|
Identificador de unidad
|
driveId | True | string |
Identificador de unidad |
|
Identificador de elemento de unidad
|
driveItemId | True | string |
Identificador de elemento de unidad |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
fields
|
fields | array of object |
fields |
|
id
|
fields.id | string |
id |
|
nombre
|
fields.name | string |
nombre |
|
value
|
fields.value | string |
value |
|
numberValue
|
fields.numberValue | string |
numberValue |
|
esRequerido
|
fields.isRequired | boolean |
esRequerido |
|
fieldType
|
fields.fieldType | integer |
fieldType |
|
users
|
fields.users | array of |
users |
|
ID de plantilla
|
templateId | string |
ID de plantilla |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
ID de archivo
|
fileReference.fileId | string |
ID de archivo |
|
nombre
|
fileReference.name | string |
nombre |
|
Ext
|
fileReference.ext | string |
Ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
cargador
|
fileReference.uploader | string |
cargador |
|
creado
|
fileReference.created | string |
creado |
|
tipo MIME
|
fileReference.mimeType | string |
tipo MIME |
|
version
|
fileReference.version | integer |
version |
|
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 |
|
nombre
|
name | string |
nombre |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Búsqueda avanzada
Buscar documentos mediante una consulta de búsqueda avanzada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
|
object |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
nombre
|
result.fields.name | string |
nombre |
|
value
|
result.fields.value | string |
value |
|
numberValue
|
result.fields.numberValue | integer |
numberValue |
|
esRequerido
|
result.fields.isRequired | boolean |
esRequerido |
|
fieldType
|
result.fields.fieldType | integer |
fieldType |
|
users
|
result.fields.users | array of |
users |
|
ID de plantilla
|
result.templateId | string |
ID de plantilla |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
ID de archivo
|
result.fileReference.fileId | string |
ID de archivo |
|
nombre
|
result.fileReference.name | string |
nombre |
|
Ext
|
result.fileReference.ext | string |
Ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
cargador
|
result.fileReference.uploader | string |
cargador |
|
creado
|
result.fileReference.created | string |
creado |
|
tipo MIME
|
result.fileReference.mimeType | string |
tipo MIME |
|
version
|
result.fileReference.version | integer |
version |
|
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 |
|
nombre
|
result.name | string |
nombre |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Cargar documento
Cargar un documento en Raptor Document Warehouse
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Nombre
|
name | True | string |
Nombre |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Contenido del archivo
|
body | True | binary |
Contenido binario del documento |
Devoluciones
| Nombre | Ruta de acceso | 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 de plantilla
|
templateId | string |
ID de plantilla |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
nombre
|
name | string |
nombre |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Consulta de usuarios
Consulta a todos los usuarios
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
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 |
|
|
nombre
|
name | string |
nombre |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
estado
|
result.status | integer |
estado |
|
Nombre para mostrar
|
result.displayName | string |
Nombre para mostrar |
|
primaryEmail
|
result.primaryEmail | string |
primaryEmail |
|
firstName
|
result.firstName | string |
firstName |
|
apellido
|
result.surname | string |
apellido |
|
cultura
|
result.culture | string |
cultura |
|
roles
|
result.roles | array of string |
roles |
|
isSystemUser
|
result.isSystemUser | boolean |
isSystemUser |
|
gerente
|
result.manager | string |
gerente |
|
total
|
total | integer |
total |
Consultar documentos
Consulta de todos los documentos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
obligatorioTags
|
obligatoryTags | array of string |
obligatorioTags |
|
|
tagsInHierarchy
|
tagsInHierarchy | array of string |
tagsInHierarchy |
|
|
fieldQueryExpression
|
fieldQueryExpression | object |
fieldQueryExpression |
|
|
excludeTagsInHierarchy
|
excludeTagsInHierarchy | array of string |
excludeTagsInHierarchy |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
nombre
|
name | string |
nombre |
|
|
containsName
|
containsName | string |
containsName |
|
|
ordenarPor
|
orderBy | integer |
0 = Nothing, 1 = Name, 2 = Size, 3 = Tiempo de carga |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Devoluciones
| Nombre | Ruta de acceso | 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 de plantilla
|
result.templateId | string |
ID de plantilla |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
nombre
|
result.fileReference.name | string |
nombre |
|
Ext
|
result.fileReference.ext | string |
Ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
cargador
|
result.fileReference.uploader | string |
cargador |
|
creado
|
result.fileReference.created | string |
creado |
|
tipo MIME
|
result.fileReference.mimeType | string |
tipo MIME |
|
version
|
result.fileReference.version | integer |
version |
|
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 |
|
nombre
|
result.name | string |
nombre |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Crear campo
Crear un nuevo campo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Método de acción
|
method | string |
Método que se va a usar al llamar a la API |
|
|
id
|
id | string |
id |
|
|
tenantId
|
tenantId | string |
tenantId |
|
|
código
|
code | string |
código |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
esRequerido
|
isRequired | boolean |
esRequerido |
|
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
|
defaultValue
|
defaultValue | string |
defaultValue |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
|
parentTagId
|
parentTagId | string |
parentTagId |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
fieldType
|
fieldType | integer |
fieldType |
|
esRequerido
|
isRequired | boolean |
esRequerido |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Desasociar documento
Mover el archivo de SharePoint al almacenamiento de Raptor
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
azureDirectoryId
|
azureDirectoryId | string |
azureDirectoryId |
|
|
driveId
|
driveId | string |
driveId |
|
|
driveItemId
|
driveItemId | string |
driveItemId |
Descargar documento
Descargar un documento por su identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id
|
id | True | string |
Identificador del documento |
Devoluciones
Documento descargado
- Contenido del documento
- object
Eliminar documento
Eliminar documento por su identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id
|
id | True | string |
Id |
Establecer origen externo
Establecer el origen externo para filereference
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de referencia de archivo
|
fileReferenceId | True | string |
Identificador de la referencia de archivo |
|
Body
|
body | True | string |
Body |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de archivo
|
fileId | string |
ID de archivo |
|
nombre
|
name | string |
nombre |
|
Ext
|
ext | string |
Ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
cargador
|
uploader | string |
cargador |
|
creado
|
created | string |
creado |
|
tipo MIME
|
mimeType | string |
tipo MIME |
|
version
|
version | integer |
version |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Establecimiento del proveedor de almacenamiento principal para el documento
Establecimiento del providor de almacenamiento principal para un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de referencia de archivo
|
fileReferenceId | True | string |
Identificador de la referencia de archivo |
|
Identificador del proveedor de almacenamiento
|
storageProviderId | True | string |
Identificador del proveedor de almacenamiento |
|
Eliminación de Raptor Storage
|
removeRaptorStorage | boolean |
Eliminación del almacenamiento de Raptor |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de archivo
|
fileId | string |
ID de archivo |
|
nombre
|
name | string |
nombre |
|
Ext
|
ext | string |
Ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
cargador
|
uploader | string |
cargador |
|
creado
|
created | string |
creado |
|
tipo MIME
|
mimeType | string |
tipo MIME |
|
version
|
version | integer |
version |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Etiquetar documento
Agregar una etiqueta a un documento mediante un identificador de documento y un identificador de etiqueta
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. de documento
|
documentId | True | string |
Identificador del documento |
|
Identificador de etiqueta
|
tagId | True | string |
Identificador de la etiqueta |
|
Volver a etiquetar
|
reTag | boolean |
Si se debe volver a etiquetar el documento |
Etiquetas de búsqueda
Consulta de todas las etiquetas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
|
directParentTagId
|
directParentTagId | string |
directParentTagId |
|
|
hasNoParentTag
|
hasNoParentTag | boolean |
hasNoParentTag |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
nombre
|
name | string |
nombre |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
value
|
result.labels.value | string |
value |
|
tagRelations
|
result.tagRelations | array of string |
tagRelations |
|
código
|
result.code | string |
código |
|
externalEntityName
|
result.syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
result.syncDetails.source | string |
source |
|
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 |
Generación de suscripciones de sitio
Generación de una suscripción para un sitio ad hoc
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador del proveedor de almacenamiento
|
storageProviderId | True | string |
Identificador del proveedor de almacenamiento |
|
Tipo de contenido
|
Content-Type | string |
Tipo de contenido |
|
|
Body
|
body | True | string |
Body |
Insertar archivo externo
Insertar dirección URL del archivo externo como documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Filename
|
filename | True | string |
Filename |
|
body
|
body | string |
body |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of |
tags |
|
fields
|
fields | array of |
fields |
|
ID de plantilla
|
templateId | string |
ID de plantilla |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nombre
|
name | string |
nombre |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Obtención de metadatos de documento
Obtención de metadatos de documento mediante el identificador de documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id
|
id | True | string |
Id |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
ID de plantilla
|
templateId | string |
ID de plantilla |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
ID de archivo
|
fileReference.fileId | string |
ID de archivo |
|
nombre
|
fileReference.name | string |
nombre |
|
Ext
|
fileReference.ext | string |
Ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
cargador
|
fileReference.uploader | string |
cargador |
|
creado
|
fileReference.created | string |
creado |
|
tipo MIME
|
fileReference.mimeType | string |
tipo MIME |
|
version
|
fileReference.version | integer |
version |
|
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 |
|
nombre
|
name | string |
nombre |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Obtención de metadatos de documento por referencia de archivo
Obtención de metadatos de documento mediante un identificador de referencia de archivo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de referencia de archivo
|
fileReferenceId | True | string |
Identificador de la referencia de archivo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
ID de plantilla
|
templateId | string |
ID de plantilla |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
nombre
|
name | string |
nombre |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Obtención de varias etiquetas
Obtener varias selecciones de etiquetas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
ids
|
ids | array of string |
Matriz de identificadores de etiqueta |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
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 |
Obtención del proveedor de almacenamiento por identificador
Obtención del proveedor de almacenamiento mediante el identificador del proveedor de almacenamiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id
|
id | True | string |
Id |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nombre
|
name | string |
nombre |
|
baseUri
|
baseUri | string |
baseUri |
|
siteConfigurations
|
siteConfigurations | array of object |
siteConfigurations |
|
id
|
siteConfigurations.id | string |
id |
|
camino
|
siteConfigurations.path | string |
camino |
|
tagContext
|
siteConfigurations.tagContext | array of string |
tagContext |
|
isActive
|
isActive | boolean |
isActive |
|
directoryId
|
directoryId | string |
directoryId |
|
lastSubscriptionExpiryCheck
|
lastSubscriptionExpiryCheck | string |
lastSubscriptionExpiryCheck |
Obtención del sistema externo por identificador
Obtención de un sistema externo mediante el identificador de sistema externo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. del sistema externo
|
externalSystemId | True | string |
Identificador del sistema externo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
nombre
|
name | string |
nombre |
|
hasUserUI
|
hasUserUI | boolean |
hasUserUI |
Obtención del token de usuario
Solicitud de un token de usuario para usarlo en las acciones
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del sistema externo
|
externalSystemID | True | string |
Identificador del sistema externo |
|
Secreto
|
secret | True | string |
Secreto del sistema externo |
|
Nombre de usuario externo
|
externalUserName | True | string |
Nombre de usuario usado para el sistema externo |
Devoluciones
Token para autenticarse en un inquilino de Raptor
- Token
- string
Obtención del usuario por identificador
Obtener un usuario por su identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
ID de usuario
|
userId | True | string |
Id. de usuario |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
estado
|
status | integer |
estado |
|
Nombre para mostrar
|
displayName | string |
Nombre para mostrar |
|
primaryEmail
|
primaryEmail | string |
primaryEmail |
|
firstName
|
firstName | string |
firstName |
|
apellido
|
surname | string |
apellido |
|
cultura
|
culture | string |
cultura |
|
roles
|
roles | array of string |
roles |
|
isSystemUser
|
isSystemUser | boolean |
isSystemUser |
|
gerente
|
manager | string |
gerente |
Obtener campo por código
Obtener un campo por su código
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Código
|
code | True | string |
Código de etiqueta |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
fieldType
|
fieldType | integer |
fieldType |
|
esRequerido
|
isRequired | boolean |
esRequerido |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obtener campo por identificador
Obtener un campo por el identificador de campo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. de campo
|
fieldId | True | string |
Id. de campo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
fieldType
|
fieldType | integer |
fieldType |
|
esRequerido
|
isRequired | boolean |
esRequerido |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obtener campos de plantilla
Obtener todos los campos de una plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de plantilla
|
templateId | True | string |
Identificador de la plantilla |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
fieldType
|
fieldType | integer |
fieldType |
|
esRequerido
|
isRequired | boolean |
esRequerido |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Obtener etiqueta por código
Obtener etiqueta por su código
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Código
|
code | True | string |
Código de etiqueta |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
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 |
Obtener etiqueta por identificador
Recuperación de una etiqueta mediante el identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de etiqueta
|
tagId | True | string |
Identificador de la etiqueta |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
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 |
Obtener o crear una etiqueta
Crea una etiqueta o la recupera si existe una etiqueta con un código coincidente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
method
|
method | True | string |
method |
|
código
|
code | string |
código |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
Valor de etiqueta |
|
|
parentTagId
|
parentTagId | string |
Identificador de la etiqueta primaria |
Obtener plantilla por código
Obtención de una plantilla mediante el código de plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Código
|
code | True | string |
Código de etiqueta |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nombre
|
name | string |
nombre |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
secundario
|
children | array of object |
secundario |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
ID de plantilla
|
children.templateId | string |
ID de plantilla |
|
esRequerido
|
children.isRequired | boolean |
esRequerido |
|
id
|
children.template.id | string |
id |
|
nombre
|
children.template.name | string |
nombre |
|
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 |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
secundario
|
children.template.children | array of object |
secundario |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
ID de plantilla
|
children.template.children.templateId | string |
ID de plantilla |
|
esRequerido
|
children.template.children.isRequired | boolean |
esRequerido |
|
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 |
Obtener plantilla por identificador
Obtención de una plantilla por su identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Identificador de plantilla
|
templateId | True | string |
Identificador de la plantilla |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
nombre
|
name | string |
nombre |
|
tenantId
|
tenantId | string |
tenantId |
|
código
|
code | string |
código |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
secundario
|
children | array of object |
secundario |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
ID de plantilla
|
children.templateId | string |
ID de plantilla |
|
esRequerido
|
children.isRequired | boolean |
esRequerido |
|
id
|
children.template.id | string |
id |
|
nombre
|
children.template.name | string |
nombre |
|
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 |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
secundario
|
children.template.children | array of object |
secundario |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
ID de plantilla
|
children.template.children.templateId | string |
ID de plantilla |
|
esRequerido
|
children.template.children.isRequired | boolean |
esRequerido |
|
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 |
Plantillas de consulta
Consulta de todas las plantillas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
languageCode
|
languageCode | integer |
languageCode |
|
|
contextTags
|
contextTags | array of string |
contextTags |
|
|
ordenarPor
|
orderBy | integer |
ordenarPor |
|
|
nombre
|
name | string |
nombre |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
resultado |
|
id
|
result.id | string |
id |
|
nombre
|
result.name | string |
nombre |
|
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 |
|
value
|
result.labels.value | string |
value |
|
fields
|
result.fields | array of string |
fields |
|
secundario
|
result.children | array of object |
secundario |
|
id
|
result.children.id | string |
id |
|
tenantId
|
result.children.tenantId | string |
tenantId |
|
masterTemplateId
|
result.children.masterTemplateId | string |
masterTemplateId |
|
ID de plantilla
|
result.children.templateId | string |
ID de plantilla |
|
esRequerido
|
result.children.isRequired | boolean |
esRequerido |
|
template
|
result.children.template | string |
template |
|
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 |
Quitar etiqueta del documento
Quitar una etiqueta de un documento mediante un identificador de documento y un identificador de etiqueta
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
Id. de documento
|
documentId | True | string |
Identificador del documento |
|
Identificador de etiqueta
|
tagId | True | string |
Identificador de la etiqueta |
Resolución del contexto
Resuelve una etiqueta mediante la configuración de entidad.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token usado para la autenticación (consulte "Obtener token de usuario") |
|
source
|
source | string |
source |
|
|
entityName
|
entityName | string |
entityName |
|
|
legalEntity
|
legalEntity | string |
legalEntity |
|
|
fields
|
fields | string |
fields |
Devoluciones
| Nombre | Ruta de acceso | 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 |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
código
|
code | string |
código |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
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 |
Definiciones
objeto
Este es el tipo 'object'.
cuerda / cadena
Este es el tipo de datos básico "string".