ExcelExport

Resumen del método

GET/scr/api/ExcelExport

Descripción

Utilice este método para exportar una representación Excel de un espacio, proceso o decisión.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	Microsoft Excel
Requiere autenticación	Sí. El usuario debe tener al menos acceso de participante al elemento.
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	Aún no

Parámetros

Nombre	Ubicación	Descripción	Obligatorio	Tipo
decisionID	Consulta	ID de la decisión a exportar. Sólo se debe especificar uno de los siguientes: spaceID, processID y decisionID.	Nee	Serie
excludeData	Consulta	Lista de datos a excluir. Las opciones se especifican como valores separados por comas. Los valores válidos son blueprints, processItems, processDetails, processPolicies, processComments, decisions, decisionItems, decisionDetails, decisionPolicies, decisionComments, documentation y attachments. Si blueprints están excluidos, también están excluidos processItems, processDetails, processPolicies y processComments. De forma similar, si decisions están excluidos, también están excluidos decisionItems, decisionDetails, decisionPolicies y decisionComments.	Nee	Serie
exportToSingleFile	Consulta	Si este valor es true y el valor de includeSubspaces es true, el espacio y todos los subespacios se exportan a un único archivo XLSX. Se necesita un spaceID.	Nee	Booleano
includeSubspaces	Consulta	Si el valor es true, se exportan también los subespacios. Cada espacio se exporta a un archivo XLSX distinto. Este parámetro sólo es aplicable cuando se especifica spaceID.	Nee	Booleano
processID	Consulta	ID del proceso para exportar. Sólo se debe especificar uno de los siguientes: spaceID, processID y decisionID.	Nee	Serie
spaceID	Consulta	ID del espacio a exportar. Sólo se debe especificar uno de los siguientes: spaceID, processID y decisionID.	Nee	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

Exportación Excel del espacio, proceso o decisión que se ha exportado. El formato es, o bien un único archivo Excel (.xlsx), o un archivo comprimido cuando includeSubspaces tiene el valor true. Si includeSubspaces y exportToSingleFile son verdaderos, el espacio y todos sus subespacios se exportan a un único archivo.

Entrada de ejemplo

Este ejemplo muestra cómo utilizar las API ExcelExport y Search para exportar un espacio y los subespacios correspondientes dado un nombre de espacio.

La muestra utiliza la biblioteca json4j del proyecto Apache Wink para decodificar las respuestas JSON enviadas por la API de búsqueda.

1. Descargar el archivo Java SpaceExcelExportExample.java.
2. Descargar el archivo JAR json4j .
3. Compile el ejemplo.
   • En sistemas operativos Windows:

     javac -cp .;wink-json4j-1.3.0.jar SpaceExcelExportExample.java

   • Para los sistemas operativos Linux® :

     javac -cp ./wink-json4j-1.3.0.jar SpaceExcelExportExample.java

4. Ejecútelo.

   A continuación, el sistema descarga un archivo Excel para cada uno de los espacios devueltos de la búsqueda de "Process Examples" y coloca cada archivo en \Temp\.

   • En sistemas operativos Windows:

     java -cp .;wink-json4j-1.3.0.jar SpaceExcelExportExample "Process Examples" \Temp\

   • Para los sistemas operativos Linux:

     java -cp .:./wink-json4j-1.3.0.jar SpaceExcelExportExample "Process Examples" \Temp\

Resultado de ejemplo

Archivo Excel

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 participante.