プロセスのOpenAPI JSON仕様
OpenAPI仕様（以前はSwagger仕様と呼ばれていました）は、REST APIエンドポイントを記述するための形式です。
アプリケーション統合は、OpenAPI仕様バージョン3.0.1をサポートします。Process Designerで作成したプロセスのペイロードのOpenAPI仕様を表示できます。
プロセスのOpenAPI JSON仕様には、入力、出力、説明、プロセスオブジェクトなどのプロセスペイロード情報が含まれています。OpenAPI仕様では、version、info、servers、paths、componentsの標準OpenAPIプロパティ要件を指定します。
OpenAPI 3.0.1仕様はSwagger 2.0よりも説明的で、複雑なドキュメントを作成することができます。
プロセスのOpenAPI JSON仕様へのアクセス
プロセスのOpenAPI 3.0仕様にアクセスするには、次の手順を実行します。
- 1［参照］ページで、OpenAPI仕様を表示するプロセスに移動します。
- 2［アクション］メニューで、［プロパティの詳細］をクリックして、生成されたOpenAPIファイルを表示します。
［プロパティの詳細］ダイアログボックスが表示されます。
次の図に、OpenAPI 3.0ファイルにアクセスするためのリンクを示します。
- 3［OpenAPI 3.0ファイルの表示］をクリックして、関連するOpenAPIファイルを表示します。
OpenAPI 3.0.1仕様が新しいタブで開きます。
プロセスのOpenAPI 3.0.1仕様には、HTTP応答ステータスコード、ステップ名、および終了ステップまたはマイルストーンステップで設定したHTTP応答ヘッダーの名前とタイプが表示されます。ただし、プロセスに受信ステップが含まれる場合、HTTP応答ステータスコードは設定に関係なく
［200 OK］のままになります。
アプリケーションの統合がサポートする応答ステータスコードの詳細については、「
HTTP応答ステータスコード」を参照してください。