OpenAPI ステップ

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分

    • サードパーティの送信 REST Web サービスの OpenAPI 仕様をインポートし、Web サービスとの統合を構築します。基礎となる REST API 操作の要求詳細は、OpenAPI 仕様に由来します。

    JSON 出力応答本文の場合、OpenAPI 仕様から複合データオブジェクト出力が作成されます。

    注:
    OpenAPI ステップ 基本システムでは使用できず、ServiceNow® 統合ハブ のサブスクリプションが必要です。 必要なプラグインを有効化した後、ステップは [統合] の下に表示されます。

    ロールと可用性

    アクションデザイナーのアクションステップとして使用できます。action_designer と open_api_admin、または admin のロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。

    フィールド

    フィールド 説明
    接続エイリアス アクションステップを実行するために使用される接続および資格情報エイリアスレコード。action_designer と connection_admin、または admin のロールを持つユーザーは、関連する接続エイリアスレコードを選択できます。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の資格情報と接続情報プロファイルを構成する必要がなくなります。また、接続情報が変更された場合に、カスタムアクションを更新する必要がありません。接続と資格情報の詳細については、「資格情報、接続、およびエイリアス」を参照してください。
    ベース URL REST 要求の接続エイリアスからのベース URL です。
    API ソース

    要求の作成に使用する OpenAPI v2.0 and v3.0 仕様を選択するオプション、または [OpenAPI をインポート] を選択して新しい OpenAPI 仕様をインポートするオプションです。YAML または JSON への URL および資格情報を指定するか、コンテンツをコピーして貼り付けて、仕様をインポートできます。
    API 操作

    操作をリストから選択するオプション。利用可能な操作は、OpenAPI 仕様の [API ソース (API Source)] フィールドで提供されます。
    リソース パス リソースのパス
    HTTP メソッド 要求を処理するために使用する HTTP メソッド
    • GET
    • POST
    • PUT
    • PATCH
    • 消去
    クエリ パラメーター

    REST エンドポイントに渡す名前と値のペア。これらのパラメーターは手動で作成することも、入力変数をパラメーター フィールドにドラッグして値を割り当てることもできます。

    重複するクエリパラメーター名を含む REST ステップ要求をサポートします。重複するクエリパラメーター名を含む REST 要求を作成すると、フローデザイナー は定義した順序と同じ順序でクエリパラメーターを要求に追加します。

    注:
    ヘッダー

    要求と一緒に送信するヘッダー。手動でヘッダーを作成するか、入力変数をパラメーター フィールドにドラッグして値を割り当てることもできます。

    重複する要求ヘッダーを含む REST ステップ要求をサポートします。重複する要求ヘッダーを含む REST 要求を作成すると、ヘッダーが定義した順序と同じ順序で送信されます。

    注:
    添付ファイル 要求を含む添付ファイルレコード。前のステップでこのレコードを検索または作成して、入力変数として定義できます。スクリプトステップで JSONStreamingBuilder および XMLStreamingBuilder API を使用して作成します。
    注:
    このフィールドは、[要求タイプ] リストから [バイナリ] を選択した場合に使用できます。
    再試行ポリシーを有効化
    エイリアスのデフォルトポリシーを上書き
    再試行ポリシー

    アクションエラー評価のフィールド

    フィールド 説明
    このステップが失敗した場合 次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「Action error evaluation」を参照して ください。
    Open API ステップのフィールド

    アクションエラー評価のフィールド

    フィールド 説明
    このステップが失敗した場合 次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「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 の範囲で設定できます。