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

スキーマを REST 要求レコードに追加して、要求に想定されるデータ構造を定義します。

始める前に

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

必要なロール：web_service_admin

このタスクについて

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

手順

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

   オプション	手順
   スクリプト化された REST API レコード内を移動する	移動先 すべて > システム Web サービス > スクリプト化 REST API. スクリプト化された REST API レコードを選択します。 [ リソース] 関連リストで、リソースを選択します。 [ 要求スキーマ ] タブで、[ 新規] を選択します。
   新しい REST 要求レコードに直接移動する	移動先 すべて > フィルター 「 sys_ws_request_spec.form」と入力します。 [ API ] フィールドで、API を選択します。 [ API リソース ] フィールドで、要求スキーマを指定する API リソースを選択します。 [ バージョン] フィールドで、API リソースバージョンを選択します。 [ HTTP メソッド] フィールドで、要求スキーマを指定するメソッド (PUT など) を選択します。

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

タスクの結果

要求本文の構造を定義するために使用したスキーマは、REST API エクスプローラーのエクスポート可能な OpenAPI 仕様に含まれています。OpenAPI 仕様のエクスポートの詳細については、「 OpenAPI 仕様にエクスポート」を参照してください。