ExcelExport

Récapitulatif de la méthode

GET/scr/api/ExcelExport

Description

Utilisez cette méthode pour exporter un espace, un processus ou une décision au format Excel.

Informations sur les ressources

Conditions requises	Description
Format de réponse	Microsoft Excel
Authentification requise	Oui L'utilisateur doit posséder au moins un accès de participant à l'élément.
Prise en charge des données d'identification client OAuth 2	Oui à l'aide d'un ID de service utilisateur contenant une catégorie de génération de rapports sur les artefacts
Taux limité	Pas encore

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
decisionID	Requête	ID de la décision à exporter. Indiquez une seule valeur parmi spaceID, processID et decisionID.	Non	Chaîne
excludeData	Requête	Liste des données à exclure. Les options sont spécifiées en tant que valeurs séparées par des virgules. Les valeurs valides sont blueprints, processItems, processDetails, processPolicies, processComments, decisions, decisionItems, decisionDetails, decisionPolicies, decisionComments, documentation et attachments. Si blueprints est exclu, processItems, processDetails, processPolicies et processComments sont également exclus. De même, si decisions est exclu, decisionItems, decisionDetails, decisionPolicies et decisionComments sont également exclus.	Non	Chaîne
exportToSingleFile	Requête	Si cette valeur est true et que la valeur de includeSubspaces est true, l'espace et tous les sous-espaces sont exportés vers un seul fichier XLSX. Un ID espace est requis.	Non	Booléen
includeSubspaces	Requête	Si la valeur est true, les sous-espaces sont également exportés. Chaque espace est exporté vers un fichier XLSX séparé. Ce paramètre est également applicable si une valeur spaceID est spécifiée.	Non	Booléen
processID	Requête	ID du processus à exporter. Indiquez une seule valeur parmi spaceID, processID et decisionID.	Non	Chaîne
spaceID	Requête	ID de l'espace à exporter. Indiquez une seule valeur parmi spaceID, processID et decisionID.	Non	Chaîne
X-On-Behalf-Of	En-tête	Le contexte utilisateur. La valeur doit être un nom d'utilisateur du compte. L'utilisateur doit être autorisé à effectuer l'action dans le compte et dans l'espace parent spécifié, si existant.	Requis si les informations d'identification de l'ID de service OAuth sont utilisées. Non requis lors de l'utilisation des informations d'identification du service utilisateur OAuth.	Chaîne

Réponse

Exportation de l'espace, du processus ou de la décision au format Excel. Le format est soit un fichier Excel (.xlsx) unique, soit une archive lorsque la valeur de includeSubspaces est true. Si includeSubspaces et exportToSingleFile sont tous deux définis sur true, l'espace et tous ses sous-espaces sont exportés dans un seul fichier.

Exemple d'entrée

Cet exemple montre comment utiliser les API ExcelExport et Rechercher pour exporter un espace et ses sous-espaces sous un nom d'espace.

L'exemple utilise la bibliothèque json4j du projet Wink Apache pour décoder les réponses JSON renvoyées par l'API de recherche.

1. Télécharger le fichier Java™ SpaceExcelExportExample.java.
2. Téléchargez le fichier JAR json4j .
3. Compilez l'exemple.
   • Pour les systèmes d'exploitation Windows :

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

   • Pour les systèmes d'exploitation Linux® :

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

4. Exécutez-le.

   Le système télécharge un fichier Excel pour chacun des espaces renvoyés par la recherche de "Process Examples" et place chaque fichier dans \Temp\.

   • Pour les systèmes d'exploitation Windows :

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

   • Pour les systèmes d'exploitation Linux :

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

Exemple de sortie

Fichier Excel

Propriétés de réponse

Aucun

Messages de réponse

Code HTTP	Motif
200	La demande a été exécutée avec succès.
401	L'utilisateur n'est pas autorisé à effectuer la demande.
403	L'utilisateur n'a pas accès au processus. Le processus requiert au moins un accès de participant.