Flujos de trabajo públicos de Use Case Manager

Utilice estos flujos de trabajo para descargar datos de informes en archivos CSV o JSON. Para el formato JSON, puede elegir generar un formato paginado o un informe completo. Los archivos paginados son útiles para lugares donde necesita JSON, como la interfaz de usuario, y necesita paginar a través de los resultados. Puede solicitar página por página y no todo el conjunto de resultados. Los archivos de informe completos son más rápidos de descargar que el cuerpo JSON, pero la paginación no está disponible en el formato de descarga de archivo.

Seleccione un flujo de trabajo para descargar datos de informe.

Flujo de trabajo para generar un resultado paginado en JSON

Genere el informe del Explorador de casos prácticos como una matriz JSON en una página por formato de página. Este flujo de trabajo es útil para lugares donde necesita JSON, como la interfaz de usuario, y necesita paginar. Puede solicitar página por página y no todo el conjunto de resultados. El flujo de trabajo es un proceso de 3 pasos que utiliza los puntos finales de API en el orden que se describe en la tabla siguiente:
Punto final Descripción
POST /api/use_case_explorer Genera un informe del Explorador de casos prácticos y devuelve un reportId. Al iniciar la generación de informe, debe utilizar primero este punto final. Rellene el cuerpo de la solicitud con las columnas de informe y cualquier filtro o agrupación de tablas que desee en el informe generado. Utilice el valor reportId devuelto en otras llamadas de API del flujo de trabajo.
GET /api/use_case_explorer/{reportId}/status Devuelve el estado de /api/use_case_explorer. Utilice el punto final para ver si la generación del informe se ha realizado o no correctamente.
GET /api/use_case_explorer/{reportId}/result Devuelve el resultado de /api/use_case_explorer en una matriz JSON paginada. Incluya el valor reportId que se ha devuelto del punto final /api/use_case_explorer en la vía de acceso para obtener su resultado.

Flujo de trabajo para generar y descargar informes en CSV

Genere el informe completo del Explorador de casos de uso en formato « CSV ». Este flujo de trabajo es un proceso de 5 pasos que utiliza los puntos finales de API en el orden que se describe en la tabla siguiente:

Punto final Descripción
POST /api/use_case_explorer Genera un informe del Explorador de casos prácticos y devuelve un reportId. Al iniciar la generación de informe, debe utilizar primero este punto final. Rellene el cuerpo de la solicitud con las columnas de informe y cualquier filtro o agrupación de tablas que desee en el informe generado. Utilice el valor reportId devuelto en otras llamadas de API del flujo de trabajo.
GET /api/use_case_explorer/{reportId}/status Devuelve el estado de /api/use_case_explorer. Utilice el punto final para ver si la generación del informe se ha realizado o no correctamente.
POST /api/use_case_explorer/{reportId}/download_csv Inicia la descarga del archivo CSV del informe del Explorador de casos prácticos. Incluya el valor reportId de /api/use_case_explorer result en la vía de acceso y rellene el cuerpo de la solicitud con los códigos de columna seleccionados, los parámetros de ordenación, los ID de regla o los parámetros de búsqueda para obtener un jobId.
GET /api/use_case_explorer/download_csv/{jobId}/status Comprueba el estado de un trabajo de descarga de archivo JSON de informe del Explorador de casos prácticos. Incluya el valor jobId devuelto desde el punto final /api/use_case_explorer/{reportId}/download_csv en la vía de acceso para obtener un estado sobre si el trabajo se ha completado o ha fallado.
GET /api/use_case_explorer/download_csv/{jobId}/result Devuelve el informe del Explorador de casos prácticos en un archivo CSV si el punto final /api/use_case_explorer/download_csv/{jobId}/status devuelve un estado 'Completed'. Incluya el jobId valor que devuelve el /api/use_case_explorer/{reportId}/download_csv punto final y el nombre que desea para su archivo CSV en la consulta para obtener un enlace de descarga para su archivo CSV.

Flujo de trabajo para generar y descargar informes en JSON

Genere el informe del Explorador de casos prácticos como una matriz JSON en un formato de informe completo. Este flujo de trabajo es útil si desea descargar todo el conjunto de resultados porque el archivo JSON es más rápido de descargar que el cuerpo JSON. La paginación no está disponible en el formato de descarga de archivo. El flujo de trabajo es un proceso de 5 pasos que utiliza los puntos finales de API en el orden que se describe en la tabla siguiente:

Punto final Descripción
POST /api/use_case_explorer Genera un informe del Explorador de casos prácticos y devuelve un reportId. Al iniciar la generación de informe, debe utilizar primero este punto final. Rellene el cuerpo de la solicitud con las columnas de informe y cualquier filtro o agrupación de tablas que desee en el informe generado. Utilice el valor reportId devuelto en otros puntos finales de API en el flujo de trabajo.
GET /api/use_case_explorer/{reportId}/status Devuelve el estado de /api/use_case_explorer. Utilice el punto final para ver si la generación del informe se ha realizado o no correctamente.
POST /api/use_case_explorer/{reportId}/download_json

Descarga el informe del Explorador de casos prácticos como archivo JSON. Incluya el valor reportId del punto final /api/use_case_explorer en la vía de acceso y rellene el cuerpo de los códigos de columna seleccionados, los parámetros de ordenación, los ID de regla o los parámetros de búsqueda para obtener un jobId.
GET /api/use_case_explorer/download_json/{jobId}/status

Comprueba el estado de un trabajo de descarga de archivo JSON de informe del Explorador de casos prácticos. Incluya el valor jobId devuelto desde el punto final /api/use_case_explorer/{reportId}/download_json en la vía de acceso para obtener un estado sobre si el trabajo se ha completado o ha fallado.
GET /api/use_case_explorer/download_json/{jobId}/result

Devuelve el resultado final del archivo JSON del Explorador de casos prácticos después de que el punto final /api/use_case_explorer/download_json/{jobId}/status devuelva un estado 'Completed'. Incluya el valor jobId devuelto por el punto final /api/use_case_explorer/{reportId}/download_json y el nombre que desea para el archivo JSON en la consulta para obtener un enlace de descarga para el archivo JSON.

Descarga de datos de informe

Procedimiento

  1. Seleccione un flujo de trabajo para utilizar.
  2. Pulse Pruébelo y, a continuación, complete los parámetros de solicitud para el flujo de trabajo seleccionado. Para obtener más información, consulte Filtros del Explorador de casos prácticos y Códigos de columna de informe para las API de informe.

Qué hacer a continuación

Revise los flujos de trabajo de punto final y pruebe el script de ejemplo o utilice el script como base para sus propios scripts. Utilice los filtros y las columnas de informe para entender su entorno y sus necesidades.