REST API スキーマの定義

スキーマを定義して、REST API 内の要求または応答に予想されるデータ構造を指定します。

始める前に

必要なロール：web_service_admin

このタスクについて

スキーマは、OpenAPI 3.0.1 形式の REST API の要求と応答の本文とヘッダーの構造と形式を定義するレコードです。ServiceNow AI Platformでスキーマを定義すると、そのスキーマを使用して、関連する REST API 内の要求と応答の構造が定義されます。要求と応答のスキーマデータは、API のエクスポート可能な OpenAPI 仕様で使用できるようになります。OpenAPI 仕様のエクスポートの詳細については、「 OpenAPI 仕様にエクスポート」を参照してください。

次の手順では、スキーマを手動で定義するプロセスについて説明します。非本番インスタンスでの要求スキーマ定義の自動生成の詳細については、「 API 要求定義の自動生成」を参照してください。

手順

1. 次のいずれかの方法で REST スキーマを作成します。

   オプション	手順
   スクリプト化された REST API レコード内を移動する	移動先 すべて > システム Web サービス > スクリプト化 REST API. スクリプト化された REST API レコードを選択します。 [ スキーマ] 関連リストで [ 新規] を選択します。
   新しい REST スキーマレコードに直接移動する	移動先 すべて > フィルター 「 sys_ws_schema.form」と入力します。 [ API ] フィールドで、スキーマに関連付ける API を選択または入力します。

2. [ 名前 ] フィールドにスキーマの名前を入力します。
3. [ スキーマ] フィールドで、 OpenAPI バージョン 3.0.1 形式を使用して新しいスキーマのデータタイプと構造を定義します。
   たとえば、次のエントリでは、スキーマが名を含むオブジェクトであることを指定します。名は文字列データ型です。

   { "type": "object", "properties": { "firstName": { "type": "string" } } }

4. OpenAPI バージョンを選択します。
5. [ 説明] フィールドで、新しいスキーマの予想される構造を要約します。
6. [送信] を選択します。

次のタスク

必要に応じて追加のスキーマを定義します。スキーマを使用して、REST 要求または応答で予想される構造と形式を指定します。詳細については、「API リソース要求構造の定義」または「API リソース応答構造の定義」を参照してください。