API Get Documents - Latest

Guía del usuario de Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Evolve
Automate > Automate Studio Manager
Version
Latest
Language
Español (España)
Product name
Automate Evolve
Title
Guía del usuario de Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:32:48.544670

Introducción

A partir de la versión 24.0 en adelante, fórmula o expresión de enlace que aparece en las páginas Borrador y Documento al abrir el elemento correspondiente. La API Get Documents devuelve todos los documentos con compatibilidad limitada con filtros de OData. Permite filtrar los datos pasando el filtro de OData en la URL de la API. Esta API utiliza el método GET para devolver todos los documentos.

Fórmula/expresión de enlace

{baseUrl}/#/{appname}/winforms?procDefId=<procDefIdValue>&name=<name>&lid=<lid>&readOnly=<readOnly>&solutionId=<solutionId>&dataItemId=<dataItemId>&ftype=11&composerPkgId=<solutionId>&extcont=<extcont>&pid=<pid>&r=-1&v=<v>&type=document

Si no se pasa el parámetro formView, se debe añadir un nuevo parámetro (tipo) junto con el valor asignado, en función del tipo de enlace.

Ejemplo: Debe añadirse &type=document al final del vínculo del documento.

Cuerpo de solicitud y respuesta

La API devuelve todos los borradores con compatibilidad con filtros limitados de OData en el siguiente formato de respuesta:

Contrato de datos de solicitud

Parámetros de consulta
Nombre Descripción Tipo
composerPkgId Id. de paquete de Composer (el valor es el mismo que el de solutionId) GUID
dataItemId Id. del elemento de datos GUID
extcont

Tiene contenido externo

Si se ha añadido un archivo externo al proceso de workflow.

Boolean (booleano)
ftype Tipo de formulario (valor fijo: 11) Entero
lid Id. de biblioteca GUID
name Nombre Cadena
pid Id. del proceso GUID
procDefId Id. de definición del proceso GUID
r Referente (valor fijo: -1) Entero
readOnly Cadena de solo lectura Boolean (booleano)
solutionId Id. de la solución GUID
type Tipo (valor fijo: documento) Cadena
v Versión de DataFile Entero

Ejemplo de solicitud y respuesta

Ejemplos de solicitud con filtros de ODATA:

  1. Para obtener todos los documentos
    {{RoutePrefix}}/api/v1/Processextn/GetDocuments
  2. Para obtener documentos con un ProcessId específico
    {{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=pid eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  3. Para obtener documentos con un ComposerPackageID específico
    {{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= composerPkgId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  4. Para obtener documentos con un DataItemId específico
    {{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= dataItemId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  5. Para obtener documentos con un nombre específico
    {{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=name eq testDoc

Error

[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]