要求パラメーター

このドキュメントでは、APIリクエスト呼び出し中にAPIエンドポイントまたはターゲットリソースに対して定義する必要がある様々なリクエストパラメータの概要を説明する。

API エンドポイントまたはターゲット・リソースによっては、API 要求呼び出しで以下のパラメーターを定義しなければならない場合があります。
フォーム・データ
以下のパラメーターを使用して、API クライアントが後続の API 要求呼び出しに必要とするアクセス・トークンを要求します。
表 1. フォーム・データ・パラメーター
パラメーター 説明
client_id API クライアントに割り当てられるクライアント ID。
client_secret API クライアントに割り当てられるクライアント秘密鍵。
grant_type client_credentials に設定されます。
scope このトークンに関連付けられているスコープのスペース区切りリスト。 API クライアントのスコープは openid です。
ヘッダー
Verify HTTPに以下の情報を要求します
表 2. ヘッダー・パラメーター
パラメーター 説明
Content Type

要求ヘッダーでは、クライアントがサーバーに送信したデータのタイプを示します。 応答ヘッダーでは、クライアントに返されたデータのタイプを示します。

例えば、以下のとおりです。
-H "Content-type: application/json"
Accept

クライアントが応答で理解し受け入れることができるコンテンツのタイプを示します。

例えば、以下のとおりです。
-H "Accept: application/json"
-H "Accept: image/png"
Location POST HTTP メソッド・ヘッダーで新規に作成されたオブジェクトの URL。 例えば、/<resource-noun>/<resource-id>などです。
Accept-Language クライアントが理解できる、あるいは優先する言語。
照会パラメーター
以下のパラメーターはオプションであり、API 要求の結果として返す内容と、それを返す方法に応じて指定します。
表 3. 照会パラメーター
パラメーター 説明
pagination
pagination パラメーターが渡されない場合、すべての結果が返されます。 limit または count の最大許容値は 1000 です。
  • count は、データ・ストアから返される結果の総数です。
  • page は、要求されたページです。
  • limit は、1 ページに返される結果の総数です。
sort

各属性には、接頭部として + または - (+ は昇順、- は降順) のいずれかを付ける必要があります。

複数の属性はコンマ (,) で区切る必要があります。
search
以下のものに対する有効な演算子:
  • ストリングは = , != および contains です。
  • ブール値は = および != です。
  • 番号は、 >=、 >、 <=、 <、 =、および != です。
filter 有効な形式は、包含のみまたは除外のみのいずれかです。 複数のフィルター・パラメーターはコンマ (,) で区切る必要があります。
本文

このパラメーターは POST 要求、PUT 要求、および PATCH 要求に使用します。 ここでは、作成または更新される属性および値を定義します。 データ・タイプの「モデル」または「値の例」をクリックすると、本文で定義する必要がある属性 (形式やサンプル値を含む) が表示されます。

「パラメーター・コンテンツ・タイプ (Parameter content type)」は application/jsonです。 コンテンツは JSON ファイル形式で保管されます。