Scripted REST API リソースの作成

Scripted REST API リソースを作成して、HTTP メソッド、処理スクリプトを定義し、親サービスの設定を上書きします。

始める前に

リソースを作成する前に、Scripted REST API を定義する必要があります。

必要なロール：web_service_admin

このタスクについて

デフォルトでは、作成するすべての新しい Scripted REST API リソースには snc_external ロールを持つユーザーが API に要求を行うことを禁止する ACL が含まれています。

手順

1. 移動先 すべて > System Web Services > スクリプト済み REST API.
2. Scripted REST API レコードを選択します。
3. [リソース] 関連リストで、[新規] をクリックします。
4. [名前] を入力します。
   リソース名は、API に要求を送信するための URI に影響します。
5. このリソースが実装する [HTTP メソッド] (GET など) を選択します。
6. [スクリプト] フィールドで、操作で要求を解析して応答する方法を定義します。
7. オプション: 必要に応じて、さまざまなセキュリティ設定や有効なコンテンツタイプを指定するなどして、親 REST API の設定を上書きします。
8. オプション: [ドキュメント] タブで、リソースへのアクセス方法を説明する [簡単な説明] を入力します。
   この情報は、REST API エクスプローラーを使用してこのリソースを探索するときに表示されます。
9. [送信] をクリックします。

次のタスク

リソースを作成したら、ヘッダーとクエリパラメーターを関連付けることができます。詳細については、「 スクリプト化された REST API ヘッダーの定義 」および「 利用可能なクエリパラメーターの定義」を参照してください。