---
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


---

# API リソース要求構造の定義

# API リソース要求構造の定義 {#ariaid-title1}

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

スキーマを REST 要求レコードに追加して、要求に想定されるデータ構造を定義します。{#add-schema-rest-api-request__patch-rn-ap1-1}

## 始める前に

要求構造を定義する前に、少なくとも 1 つの REST API リソースと少なくとも 1 つのスキーマを REST API で定義する必要があります。

必要なロール：web_service_admin

## このタスクについて

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

## 手順

1. 次のいずれかの方法で、新しい REST 要求レコードに移動します。  
   スクリプト化された REST API レコード内を移動する場合、REST 要求レコードのほとんどのフィールドは事前に入力されています。

   | オプション | 手順 |
   | スクリプト化された REST API レコード内を移動する | 1. 移動先 すべてシステム Web サービススクリプト化 REST API. 2. スクリプト化された REST API レコードを選択します。 3. \[ リソース\] 関連リストで、リソースを選択します。 4. \[ 要求スキーマ \] タブで、\[ 新規\] を選択します。 |
   | 新しい REST 要求レコードに直接移動する | 1. 移動先 すべてフィルター 「 <kbd class="ph userinput">sys_ws_request_spec.form</kbd>」と入力します。 2. \[ API \] フィールドで、API を選択します。 3. \[ API リソース \] フィールドで、要求スキーマを指定する API リソースを選択します。 4. \[ バージョン\] フィールドで、API リソースバージョンを選択します。 5. \[ HTTP メソッド\] フィールドで、要求スキーマを指定するメソッド (PUT など) を選択します。 {#add-schema-rest-api-request__ol_nth_hrc_l3c} |
   |-|-|

   {#add-schema-rest-api-request__choicetable_ehs_g3d_j3c}
2. \[ スキーマ\] フィールドで、リソースの要求本文の構造と形式を定義するスキーマを検索または入力します。
3. \[ 説明\] フィールドで、REST 要求の想定される形式を要約します。
4. \[送信\] を選択します。

## タスクの結果

要求本文の構造を定義するために使用したスキーマは、REST API エクスプローラーのエクスポート可能な OpenAPI 仕様に含まれています。OpenAPI 仕様のエクスポートの詳細については、「 [OpenAPI 仕様にエクスポート](https://servicenow-prod.fluidtopics.net/r6ceUPmx_AA5AGzwg8a~hg "REST API を OpenAPI 仕様としてエクスポートして、別の Web サービスツールにインポートします。")」を参照してください。