公式の Use Case Manager API ワークフロー
レポート・データを CSV ファイルまたは JSON ファイルにダウンロードするには、以下のワークフローを使用します。 JSON フォーマットの場合、ページ編集されたフォーマットを生成するか、レポート全体を生成するかを選択できます。 ページ編集されたファイルは、JSON が必要な場所 (ユーザー・インターフェースなど) で、結果をページ編集する必要がある場合に役立ちます。 結果セット全体ではなく、ページごとに要求できます。 フル・レポート・ファイルは JSON 本文よりもダウンロード速度が速くなりますが、ページ編集はファイル・ダウンロード形式では使用できません。
レポート・データをダウンロードするワークフローを選択します。
ページ編集済みの結果を JSON で生成するためのワークフロー
| エンドポイント | 説明 |
|---|---|
| POST /api/use_case_explorer | ユース・ケース・エクスプローラー・レポートを生成して、reportId を返します。 レポート生成を開始する際、このエンドポイントを最初に使用する必要があります。 要求の本文に、レポート列と、生成されるレポートに含めるフィルターまたは表グループを入力します。 返された reportId 値を、ワークフロー内の他の API 呼び出しに使用します。 |
| GET /api/use_case_explorer/{reportId}/status | /api/use_case_explorer の状況を返します。 このエンドポイントを使用して、レポート生成が成功または失敗したかを確認します。 |
| GET /api/use_case_explorer/{reportId}/result | /api/use_case_explorer の結果をページ編集済みの JSON 配列で返します。 /api/use_case_explorer エンドポイントから返された reportId 値をパスに含めて、結果を取得します。 |
CSV でレポートを生成してダウンロードするためのワークフロー
ユースケースエクスプローラーの完全なレポートを CSV 形式で生成します。 このワークフローは、以下の表で説明されている順序で API エンドポイントを使用する 5 ステップのプロセスです。
| エンドポイント | 説明 |
|---|---|
| POST /api/use_case_explorer | ユース・ケース・エクスプローラー・レポートを生成して、reportId を返します。 レポート生成を開始する際、このエンドポイントを最初に使用する必要があります。 要求の本文に、レポート列と、生成されるレポートに含めるフィルターまたは表グループを入力します。 返された reportId 値を、ワークフロー内の他の API 呼び出しに使用します。 |
| GET /api/use_case_explorer/{reportId}/status | /api/use_case_explorer の状況を返します。 このエンドポイントを使用して、レポート生成が完了または失敗したかを確認します。 |
| POST /api/use_case_explorer/{reportId}/download_csv | ユース・ケース・エクスプローラー・レポートの CSV ファイルのダウンロードを開始します。 /api/use_case_explorer result の reportId 値をパスに組み込み、選択した列コード、ソート・パラメーター、ルール ID、または検索パラメーターを要求の本体に入力して、 jobIdを取得します。 |
| GET /api/use_case_explorer/download_csv/{jobId}/status | ユース・ケース・エクスプローラー・レポートの CSV ファイルのダウンロード・ジョブの状況を確認します。 /api/use_case_explorer/{reportId}/download_csv エンドポイントから返された jobId 値をパスに含めて、ジョブが完了したか失敗したかの状況を取得します。 |
| GET /api/use_case_explorer/download_csv/{jobId}/result | /api/use_case_explorer/download_csv/{jobId}/status エンドポイントが「完了」状況を返す場合、ユース・ケース・エクスプローラー・レポートを CSV ファイルで返します。 エンド /api/use_case_explorer/{reportId}/download_csv ポイントから返される値 jobId と、 CSV ファイルに付けたい名前をクエリに含め、 CSV ファイルのダウンロードリンクを取得します。 |
JSON でレポートを生成してダウンロードするためのワークフロー
ユース・ケース・エクスプローラー・レポートを完全なレポート形式の JSON 配列として生成します。 このワークフローは、JSON ファイルの方が JSON 本体よりもダウンロードが速いため、結果セット全体をダウンロードする場合に役立ちます。 ページ編集は、ファイル・ダウンロード・フォーマットでは使用できません。 ワークフローは、以下の表で説明されている順序で API エンドポイントを使用する 5 ステップのプロセスです。
| エンドポイント | 説明 |
|---|---|
| POST /api/use_case_explorer | ユース・ケース・エクスプローラー・レポートを生成して、reportId を返します。 レポート生成を開始する際、このエンドポイントを最初に使用する必要があります。 要求の本文に、レポート列と、生成されるレポートに含めるフィルターまたは表グループを入力します。 返された reportId 値を、ワークフロー内の他の API エンドポイントで使用します。 |
| GET /api/use_case_explorer/{reportId}/status | /api/use_case_explorer の状況を返します。 このエンドポイントを使用して、レポート生成が成功または失敗したかを確認します。 |
| POST /api/use_case_explorer/{reportId}/download_json | ユース・ケース・エクスプローラー・レポートを JSON ファイルとしてダウンロードします。 パスに /api/use_case_explorer エンドポイントの reportId 値を含め、選択した列コード、ソート・パラメーター、ルール ID、または検索パラメーターを本体に入力して、 jobIdを取得します。 |
| GET /api/use_case_explorer/download_json/{jobId}/status | ユース・ケース・エクスプローラー・レポートの JSON ファイルのダウンロード・ジョブの状況を確認します。 /api/use_case_explorer/{reportId}/download_json エンドポイントから返された jobId 値をパスに含めて、ジョブが完了したか失敗したかの状況を取得します。 |
| GET /api/use_case_explorer/download_json/{jobId}/result | /api/use_case_explorer/download_json/{jobId}/status エンドポイントが「完了」状況を返した後に、Use Case Explorer の JSON ファイルの最終結果を返します。 /api/use_case_explorer/{reportId}/download_json エンドポイントによって返される jobId 値と、JSON ファイルのダウンロード・リンクを取得するための照会で使用する JSON ファイルの名前を指定します。 |