OpenAPI/Postman ステップ
サードパーティの送信 REST Web サービスの OpenAPI 仕様または Postman コレクションをインポートし、Web サービスとの統合を構築します。基になっている REST API 操作の要求の詳細は、OpenAPI 仕様または Postman コレクションから派生しています。
JSON 出力応答本文では、OpenAPI 仕様または Postman コレクションから複合データオブジェクト出力が作成されます。
ロールと使用可用性
アクションデザイナーのアクションステップとして使用できます。action_designer と open_api_admin、または admin のロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。
フィールド
| フィールド | 説明 |
|---|---|
| 接続エイリアス | アクションステップを実行するために使用される接続および資格情報エイリアスレコード。action_designer と connection_admin、または admin のロールを持つユーザーは、関連する接続エイリアスレコードを選択できます。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の認証情報と接続情報プロファイルを構成する必要がなくなります。また、接続情報が変更された場合に、カスタムアクションを更新する必要がありません。接続と資格情報の詳細については、「資格情報、接続、およびエイリアス」を参照してください。 |
| ベース URL | REST 要求の接続エイリアスからのベース URL です。 |
| 詳細ビューの切り替え | 要求の詳細を表示または非表示にするオプション。有効にすると、要求のリソースパス、HTTP メソッド、クエリパラメーター、ヘッダー、およびアクション出力を表示および設定できます。 |
| API ソース |
利用可能なインポート済み API のリストから API を選択するオプション。 |
| インポート仕様 | OpenAPI (v2.0 または v3.0) 仕様または Postman コレクション (バージョン 2.0.0 または 2.1.0) をインポートできるオプション。仕様またはコレクションに対する URL および認証情報を指定するか、JSON コンテンツを手動でコピーして貼り付けると、OpenAPI 仕様または Postman コレクションをインポートできます。 |
| API 操作 |
操作をリストから選択するオプション。利用可能な操作は、[API ソース] フィールドの OpenAPI 仕様または Postman コレクションで指定されます。 |
| 添付ファイルとして保存 | 応答をレコードとして添付ファイル [sys_attachment] テーブルに保存するかどうかを指定するオプション。 |
| リソースパス | リソースのパス |
| HTTP メソッド | 要求を処理するために使用する HTTP メソッド
|
| クエリ パラメーター |
REST エンドポイントに渡す名前と値のペア。これらのパラメーターは手動で作成することも、入力変数をパラメーター フィールドにドラッグして値を割り当てることもできます。 重複するクエリパラメーター名を含む REST ステップ要求をサポートします。重複するクエリパラメーター名を含む REST 要求を作成すると、ワークフロースタジオ は定義した順序と同じ順序でクエリパラメーターを要求に追加します。 注:
OpenAPI 仕様をインポートする際は、システムは仕様にあるするすべてのパラメーターとヘッダーを REST ステップに追加します。最後の REST ステップの値を確認して、要求に送信しないパラメーターを削除します。たとえば API が JSON と XML の両方のコンテンツタイプヘッダーを受け入れた場合は、システムは両方のヘッダーを REST ステップに追加します。応答で受け取るコンテンツタイプに応じて、いずれかのヘッダーを削除します。 |
| ヘッダー |
要求と一緒に送信するヘッダー。手動でヘッダーを作成するか、入力変数をパラメーター フィールドにドラッグして値を割り当てることもできます。 重複する要求ヘッダーを含む REST ステップ要求をサポートします。重複する要求ヘッダーを含む REST 要求を作成すると、ヘッダーが定義した順序と同じ順序で送信されます。 注:
OpenAPI 仕様をインポートする際は、システムは仕様にあるするすべてのパラメーターとヘッダーを REST ステップに追加します。最後の REST ステップの値を確認して、要求に送信しないパラメーターを削除します。たとえば API が JSON と XML の両方のコンテンツタイプヘッダーを受け入れた場合は、システムは両方のヘッダーを REST ステップに追加します。応答で受け取るコンテンツタイプに応じて、いずれかのヘッダーを削除します。 |
| 添付ファイル | 要求を含む添付ファイルレコード。前のステップでこのレコードを検索または作成して、入力変数として定義できます。スクリプトステップで JSONStreamingBuilder および XMLStreamingBuilder API を使用して作成します。 注: このフィールドは、[要求タイプ] リストから [バイナリ] を選択した場合に使用できます。 |
| 再試行ポリシーを有効化 | 再試行ポリシーを有効にするオプション。詳細については、「再試行ポリシー」を参照してください。 |
| エイリアスのデフォルトポリシーを上書き | デフォルトの再試行ポリシーを上書きするオプション。 接続リストの [インラインで接続を定義] が選択されている場合は、このチェックボックスは適用されません。 |
| 再試行ポリシー | 接続エイリアスに関連付けられているデフォルトの再試行ポリシー。エイリアスのデフォルトポリシーを上書きが選択されている場合は、デフォルトの再試行ポリシーを上書きして要件に基づいて別の既存の再試行ポリシーを選択できます。 |
アクションエラー評価
- このステップが失敗した場合
- データタイプ：Choice
次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「Action error evaluation」を参照してください。
アクションエラー評価
- このステップが失敗した場合
- データタイプ：Choice
次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「Action error evaluation」を参照してください。
既知の制限
これらの制限事項により OpenAPI 仕様から OpenAPI ステップを作成します。
- 要求本文メディアタイプ
- 要求本文は、JSON のメディアタイプのみをサポートしています。 注:OpenAPI スキーマに additionalProperties プロパティがある場合、またはプロパティがひとつもない場合は、文字列タイプの出力オブジェクトが作成されます。
- OpenAPI 3.0 コンポーネント
OpenAPI 3.0 では、API をさらに詳細に記述するための新しいコンポーネントが Swagger 2.0 に追加されています。OpenAPI ステップの OpenAPI サポートは、これらのコンポーネントの一部をサポートしていますが、すべてをサポートしているわけではありません。現在、OpenAPI ステップはこれらのコンポーネントをサポートしていません。
- スキーマオブジェクト：additionalProperties プロパティ
- 識別子オブジェクト
- 情報オブジェクト：termsOfService、連絡先、ライセンスフィールド
- サンプルオブジェクト
- リンクオブジェクト
- コールバックオブジェクト
- セキュリティスキームオブジェクト
- セキュリティ要件オブジェクト
- タグオブジェクト
- 外部ドキュメントオブジェクト
- サーバーオブジェクト
- 仕様拡張
- 再帰参照
これらのコンポーネントの詳細については、OpenAPI ドキュメントを参照してください。「OpenAPI 仕様」を参照してください。
- サポートされる操作の最大数
- API 操作の数は、デフォルトで 500 に制限されています。ただし、システムプロパティ glide.rest.openapi.max_operation_limit を使用すると、操作の数を 1 ～ 1000 の範囲で設定できます。