プロセスのレポートの生成およびエクスポート
put
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}/report
アプリケーションのプロセスのレポートを生成およびエクスポートします。 レポートには、要件、添付へのリンク、問題およびコメントのトラッキングなどの摘要と情報を含めることができます。
リクエスト
パス・パラメータ
- processId(required): string
プロセスID
- projectId(required): string
プロジェクトID
- spaceId(required): string
スペースID
問合せパラメータ
- format: string
レポート・ファイル形式を指定します。デフォルト値:
XML許容値:[ "XML", "HTML", "PDF", "HTML/Zip" ] - showBiz: boolean
ビジネス・プロパティの表示チェック・ボックスを設定します。デフォルト値:
false - showDoc: boolean
ドキュメントの表示チェック・ボックスを設定します。デフォルト値:
false - type: string
レポート・タイプを指定します。デフォルト値:
DETAILED_BPR許容値:[ "DETAILED_BPR", "BIZ_REQS", "ISSUES_COMMENTS", "DATA_OBJECTS", "PROCESS_VS_DATA", "DATA_VS_PROCESS", "SERVICE_VS_PROCESS", "USER_TASK", "PROCESS_PROPS", "RACI" ]
レスポンス
サポートされているメディア・タイプ
- application/xml
- text/html
- application/pdf
- application/octet-stream
200レスポンス
成功。 レポートは正常に生成されました。
401レスポンス
未認可
403レスポンス
権限が必要です。 ユーザーはレポートを生成できません。
404レスポンス
スペース/プロジェクトが見つかりません。 レポート/形式の値が無効です。
500レスポンス
レポートの生成中にエラーが発生しました。
例
次の例は、RESTリソースに対してPUTリクエストを送信して、アプリケーション内の特定のプロセスのレポートを生成およびエクスポートする方法を示しています。
リクエストの送信
次の例では、送信リクエストのコンテンツを示しています。
curl -X PUT https://example.com/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/processes/{processId}/report
説明
-
example.comは、Oracle Integrationが実行されているホストです。 -
<version>はREST APIバージョンです。
-
<spaceId>は、スペースの一意のIDです。 -
<projectId>は、プロジェクトの一意のIDです。 -
<processId>は、プロセスの一意のIDです。
レスポンス・ヘッダーの例
Status Code: 200 OK Date: Mon, 18 Mar 2022 08:39:54 GMT Content-Type: application/xml