---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# スキーマの定義

# REST API スキーマの定義 {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：2分

スキーマを定義して、REST API 内の要求または応答に予想されるデータ構造を指定します。{#define-scripted-rest-api-schema__patch-rn-ap1-1}

## 始める前に

必要なロール：web_service_admin

## このタスクについて

スキーマは、OpenAPI 3.0.1 形式の REST API の要求と応答の本文とヘッダーの構造と形式を定義するレコードです。ServiceNow AI Platformでスキーマを定義すると、そのスキーマを使用して、関連する REST API 内の要求と応答の構造が定義されます。要求と応答のスキーマデータは、API のエクスポート可能な OpenAPI 仕様で使用できるようになります。OpenAPI 仕様のエクスポートの詳細については、「 [OpenAPI 仕様にエクスポート](https://servicenow-prod.fluidtopics.net/r6ceUPmx_AA5AGzwg8a~hg "REST API を OpenAPI 仕様としてエクスポートして、別の Web サービスツールにインポートします。")」を参照してください。

次の手順では、スキーマを手動で定義するプロセスについて説明します。非本番インスタンスでの要求スキーマ定義の自動生成の詳細については、「 [API 要求定義の自動生成](https://servicenow-prod.fluidtopics.net/7XAb~YuwA5gHGiVWoCPvjA "API リソースに対して行われるサンプル要求を使用して、要求ヘッダーの関連付け、クエリパラメーターの関連付け、およびそのリソースの要求スキーマを生成します。")」を参照してください。{#define-scripted-rest-api-schema__patch-rn-ap1-2}

## 手順

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

   | オプション | 手順 |
   | スクリプト化された REST API レコード内を移動する | 1. 移動先 すべてシステム Web サービススクリプト化 REST API. 2. スクリプト化された REST API レコードを選択します。 3. \[ スキーマ\] 関連リストで \[ 新規\] を選択します。 {#define-scripted-rest-api-schema__ol_dlh_5zc_j3c} |
   | 新しい REST スキーマレコードに直接移動する | 1. 移動先 すべてフィルター 「 <kbd class="ph userinput">sys_ws_schema.form</kbd>」と入力します。 2. \[ API \] フィールドで、スキーマに関連付ける API を選択または入力します。 {#define-scripted-rest-api-schema__ol_hkp_wqc_l3c} |
   |-|-|

   {#define-scripted-rest-api-schema__choicetable_kbq_szc_j3c}
2. \[ 名前 \] フィールドにスキーマの名前を入力します。
3. \[ スキーマ\] フィールドで、 [OpenAPI バージョン 3.0.1 形式](https://spec.openapis.org/oas/v3.0.1.html)を使用して新しいスキーマのデータタイプと構造を定義します。  
   たとえば、次のエントリでは、スキーマが名を含むオブジェクトであることを指定します。名は文字列データ型です。

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

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

## 次のタスク

必要に応じて追加のスキーマを定義します。スキーマを使用して、REST 要求または応答で予想される構造と形式を指定します。詳細については、「[API リソース要求構造の定義](https://servicenow-prod.fluidtopics.net/dxOr6ogiVPxdR3XADojU4g "スキーマを REST 要求レコードに追加して、要求に想定されるデータ構造を定義します。")」または「[API リソース応答構造の定義](https://servicenow-prod.fluidtopics.net/UpgFYXyw8FiZyCzdTKgQbQ "スキーマと関連する応答ヘッダーを REST 応答に追加して、応答で想定されるデータ構造を定義します。")」を参照してください。