---
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月23日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：3分

API リソースに対して行われるサンプル要求を使用して、要求ヘッダーの関連付け、クエリパラメーターの関連付け、およびそのリソースの要求スキーマを生成します。{#autogenerate-api-request-definitions__patch-rn-ap1-1}

## 始める前に

インスタンスアドミンは、システムプロパティ glide.rest.sampling.enabled を true に設定する必要があります。パフォーマンスの問題の可能性を制限するには、非本番インスタンスでのみ API 要求定義の自動生成を有効にします。

必要なロール：web_service_admin

## 手順

1. 次のいずれかの方法で、スクリプト化された REST API 要求サンプリング構成を作成します。

   | オプション | 手順 |
   | スクリプト化された REST API レコード内を移動する | 1. 移動先 すべてシステム Web サービススクリプト化 REST サービススクリプト化 REST API. 2. スクリプト化された REST API レコードを選択します。 3. \[ リソース\] 関連リストで、リソースを選択します。 4. \[ サンプリング構成を要求 \] タブで、\[ 新規\] を選択します。 {#autogenerate-api-request-definitions__ol_sbg_mf1_s3c} |
   | 新しいスクリプト化された REST API 要求サンプリング構成に直接移動 | 1. 移動先 すべてシステム Web サービススクリプト化 Web サービススクリプト済み REST サンプリング構成. 2. \[新規\] を選択します。 3. \[REST リソース\] フィールドで、要求定義を自動的に生成するスクリプト化された REST リソースを選択または入力します。 {#autogenerate-api-request-definitions__ol_unr_rf1_s3c} |
   |-|-|

   {#autogenerate-api-request-definitions__choicetable_rjy_kf1_s3c}
2. \[ 最大サンプル数 \] フィールドに、自動定義生成のために分析するサンプル要求の数を入力します。  
   1 から 1000 までの数値を入力する必要があります。
3. \[送信\] を選択します。  
   リソースに対して行われた要求は、手順 5 で設定したサンプル数まで、分析のためにサンプリングされます。サンプルの最大数に達すると、要求サンプリング構成ステータスが \[ 解析済み\] に設定され、REST 要求ステージングスキーマをレビューできるようになります。

   サンプルの最大数に達する前にサンプリングを終了するには、要求サンプリング設定レコードから \[サンプリングの完了 \] を選択できます。
4. サンプリングが終了したら、スクリプト化された REST リソースの \[要求サンプリング構成 \] タブから番号を選択して、作成した要求サンプリング構成に戻ります。
5. \[REST 要求ステージングスキーマ\] リストからレコードを選択し、\[ヘッダー\]、\[本文\]、および \[クエリパラメーター\] フィールドで自動生成された要求定義を確認および編集します。  
   本文 構造は、 PUT および POST HTTP メソッドに対してのみ生成されます。
6. \[ コミット \] を選択して、スクリプト済み REST API リソースとそれに関連するスクリプト済み REST API サービスに定義を追加します。

## タスクの結果

* コミットされた REST 要求ステージングスキーマとサンプル要求が削除されます。
* ヘッダー フィールドのコンテンツは、リソースの要求ヘッダーの関連付けを作成するために使用されます。関連する要求ヘッダーが、関連する REST サービスの \[要求ヘッダー \] タブに追加されます。
* 本文 フィールドのコンテンツは、リソースの要求スキーマを作成するために使用されます。リソースの要求スキーマが、関連する REST サービスの \[スキーマ\] タブに追加されます。
* クエリパラメーター フィールドのコンテンツは、リソースのクエリパラメーターの関連付けを作成するために使用されます。関連するクエリパラメーターが、関連する REST サービスの \[クエリパラメーター \] タブに追加されます。
* 追加したすべてのコミット済み要求定義は、REST API エクスプローラーのエクスポート可能な OpenAPI 仕様に含まれます。OpenAPI 仕様のエクスポートの詳細については、「 [OpenAPI 仕様にエクスポート](https://servicenow-prod.fluidtopics.net/r6ceUPmx_AA5AGzwg8a~hg "REST API を OpenAPI 仕様としてエクスポートして、別の Web サービスツールにインポートします。")」を参照してください。
{#autogenerate-api-request-definitions__ul_ukg_sw5_r3c}