export/process

Utilice este recurso para exportar una revisión específica de un proceso en formato BPMN 2.0.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP Vía de acceso Descripción
GET /scr/api/export/process/{process_id}/{revision_id} Exporta una revisión específica de un proceso en formato BPMN 2.0.

GET/scr/api/export/process/{process_id}/{revision_id}

Descripción
Utilice este método para exportar una revisión específica de un proceso en formato BPMN 2.0.
Información de recursos
Requisitos Descripción
Formato de la respuesta ZIP
Requiere autenticación Sí. El usuario que solicita la exportación del proceso debe ser un editor para dicho proceso.
Permite credenciales de cliente de OAuth 2 Sí, utilizando un ID de servicio de usuario que contiene la categoría de creación de informes de artefactos
Velocidad limitada Nee
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
exportToSingleFile Consulta Este parámetro permite a los usuarios exportar los procesos como un único archivo XML compatible con BPMN 2.0, incluidos los detalles de Diagram Interchange (DI). Proporciona compatibilidad de intercambio de modelos con herramientas BPMN de terceros. El valor predeterminado es false. Nee Booleano
includeDiagramInterchange Consulta Si se debe incluir el intercambio de diagrama de BPMN2 (DI) en la exportación. El DI cubre información visual como, por ejemplo, el posicionamiento de nodos y límites, los puertos de línea y las etiquetas. El valor predeterminado es false. Nee Booleano
process_id Vía de acceso ID del proceso exportado. Sí Serie
revision_id Vía de acceso ID de la revisión exportada. Sí Serie
X-On-Behalf-Of Cabecera El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay. Necesario si se utilizan credenciales de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth. Serie
Respuesta
Los datos del proceso en formato BPMN 2.0 incluidos todos los procesos enlazados para el proceso solicitado.
Entrada de ejemplo
El ejemplo siguiente muestra cómo exportar una revisión con el valor de revision_id 1300a1 y el valor de process_id 130024.
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/export/process/130024/1300a1"
Resultado de ejemplo
Datos de archivos
Propiedades de respuesta
Ninguna
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
401

El usuario no está autorizado a realizar la petición.
403 El usuario no tiene acceso al proceso. El proceso requiere al menos acceso de editor.