Flux de travaux de l'API Case Manager à usage public

Utilisez ces flux de travaux pour télécharger des données de rapport dans des fichiers CSV ou JSON. Pour le format JSON, vous pouvez choisir de générer un format paginé ou un rapport complet. Les fichiers paginés sont utiles pour les emplacements où vous avez besoin de JSON, comme l'interface utilisateur, et vous devez mettre en page les résultats. Vous pouvez demander page par page et non la totalité de l'ensemble de résultats. Les fichiers de rapport complets sont plus rapides à télécharger que le corps JSON, mais la pagination n'est pas disponible dans le format de téléchargement de fichier.

Sélectionnez un flux de travaux pour télécharger les données de rapport.

Flux de travaux pour générer un résultat paginé au format JSON

Générez le rapport de l'explorateur de cas d'utilisation sous forme de tableau JSON dans un format page par page. Ce flux de travaux est utile pour les emplacements où vous avez besoin de JSON, comme l'interface utilisateur, et où vous devez paginer. Vous pouvez demander page par page et non la totalité de l'ensemble de résultats. Le flux de travaux est un processus en 3 étapes qui utilise les noeuds finaux d'API dans l'ordre décrit dans le tableau suivant:
Noeud final Descriptif
POST /api/use_case_explorer Génère un rapport de l'explorateur de cas d'utilisation et renvoie un reportId. Vous devez utiliser ce noeud final lorsque vous lancez la génération du rapport. Remplissez le corps de la demande avec les colonnes du rapport et les filtres ou les regroupements de tables que vous souhaitez dans le rapport généré. Utilisez la valeur reportId renvoyée dans d'autres appels d'API dans le flux.
GET /api/use_case_explorer/{reportId}/status Renvoie le statut de /api/use_case_explorer. Utilisez le noeud final pour vérifier si votre génération de rapport a réussi ou échoué.
GET /api/use_case_explorer/{reportId}/result Renvoie le résultat de /api/use_case_explorer dans un tableau JSON paginé. Incluez la valeur reportId renvoyée par le noeud final /api/use_case_explorer dans le chemin d'accès pour obtenir votre résultat.

Flux de travaux pour générer et télécharger des rapports au format CSV

Générer le rapport complet de l'explorateur de cas d'utilisation au format CSV. Ce flux de travaux est un processus en 5 étapes qui utilise les noeuds finaux d'API dans l'ordre décrit dans le tableau suivant:

Noeud final Descriptif
POST /api/use_case_explorer Génère un rapport de l'explorateur de cas d'utilisation et renvoie un reportId. Vous devez utiliser ce noeud final lorsque vous lancez la génération du rapport. Remplissez le corps de la demande avec les colonnes du rapport et les filtres ou les regroupements de tables que vous souhaitez dans le rapport généré. Utilisez la valeur reportId renvoyée dans d'autres appels d'API dans le flux.
GET /api/use_case_explorer/{reportId}/status Renvoie le statut de /api/use_case_explorer. Utilisez le noeud final pour vérifier si votre génération de rapport a abouti ou échoué.
POST /api/use_case_explorer/{reportId}/download_csv Démarre le téléchargement d'un rapport Explorateur de cas d'utilisation au format CSV. Incluez la valeur reportId de /api/use_case_explorer result dans le chemin et remplissez le corps de la demande avec les codes de colonne, les paramètres de tri, les ID de règle ou les paramètres de recherche sélectionnés pour obtenir un jobId.
GET /api/use_case_explorer/download_csv/{jobId}/status Vérifie l'état de téléchargement d'un rapport Explorateur de cas d'utilisation au format CSV. Incluez la valeur jobId renvoyée par le noeud final /api/use_case_explorer/{reportId}/download_csv dans le chemin d'accès pour obtenir un statut indiquant si votre travail a abouti ou échoué.
GET /api/use_case_explorer/download_csv/{jobId}/result Renvoie le rapport de l'explorateur de cas d'utilisation dans un fichier CSV si le noeud final /api/use_case_explorer/download_csv/{jobId}/status renvoie le statut 'Completed'. Incluez dans la requête la valeur jobId renvoyée par le noeud final /api/use_case_explorer/{reportId}/download_csv et le nom que vous souhaitez pour votre fichier CSV afin d'obtenir un lien de téléchargement pour votre fichier CSV.

Flux de travaux pour générer et télécharger des rapports au format JSON

Générez le rapport de l'explorateur de cas d'utilisation sous la forme d'un tableau JSON dans un format de rapport complet. Ce flux de travaux est utile si vous souhaitez télécharger l'ensemble des résultats car le fichier JSON est plus rapide à télécharger que le corps JSON. La pagination n'est pas disponible dans le format de téléchargement de fichier. Le flux de travaux est un processus en 5 étapes qui utilise les noeuds finaux d'API dans l'ordre décrit dans le tableau suivant:

Noeud final Descriptif
POST /api/use_case_explorer Génère un rapport de l'explorateur de cas d'utilisation et renvoie un reportId. Vous devez utiliser ce noeud final lorsque vous lancez la génération du rapport. Remplissez le corps de la demande avec les colonnes du rapport et les filtres ou les regroupements de tables que vous souhaitez dans le rapport généré. Utilisez la valeur reportId renvoyée dans d'autres noeuds finaux d'API dans le flux.
GET /api/use_case_explorer/{reportId}/status Renvoie le statut de /api/use_case_explorer. Utilisez le noeud final pour vérifier si votre génération de rapport a réussi ou échoué.
POST /api/use_case_explorer/{reportId}/download_json

Télécharge le rapport Explorateur de cas d'utilisation sous la forme d'un fichier JSON. Incluez la valeur reportId du noeud final /api/use_case_explorer dans le chemin et remplissez le corps avec les codes de colonne, les paramètres de tri, les ID de règle ou les paramètres de recherche sélectionnés pour obtenir un jobId.
GET /api/use_case_explorer/download_json/{jobId}/status

Vérifie l'état de téléchargement d'un rapport Explorateur de cas d'utilisation au format JSON. Incluez la valeur jobId renvoyée par le noeud final /api/use_case_explorer/{reportId}/download_json dans le chemin d'accès pour obtenir un statut indiquant si votre travail a abouti ou échoué.
GET /api/use_case_explorer/download_json/{jobId}/result

Renvoie le résultat final du fichier JSON de l'explorateur de cas d'utilisation après que le noeud final /api/use_case_explorer/download_json/{jobId}/status renvoie un statut 'Completed'. Incluez la valeur jobId qui est renvoyée par le noeud final /api/use_case_explorer/{reportId}/download_json et le nom que vous souhaitez pour votre fichier JSON dans la requête afin d'obtenir un lien de téléchargement pour votre fichier JSON.

Téléchargement des données de rapport

Procédure

  1. Sélectionnez un flux de travail à utiliser.
  2. Cliquez sur Try it out , puis complétez les paramètres de demande pour le flux de travaux sélectionné. Pour plus d'informations, voir Filtres de l'explorateur de cas d'utilisation et Codes de colonne de rapport pour les API de rapport.

Etape suivante

Passez en revue les flux de travaux de noeud final et essayez l'exemple de script ou utilisez le script comme base pour vos propres scripts. Utilisez les filtres et les colonnes de rapport pertinents pour votre environnement et vos besoins.