REST APIリファレンス

前へ次へ

要求本文

要求本文を使用してリソースの追加属性を渡します。要求本文で属性を渡すとき、属性はオブジェクトの一部として渡します。

例えば、loginリソースにログインするには、ログインオブジェクトの必要なusername属性とpassword属性を渡します。

一部の要求には、属性のサブオブジェクトが含まれます。サブオブジェクトは、関連する属性をリストする前に宣言します。

JSON形式

バージョン2 REST API呼び出しにJSON形式を使用するときは、次の例に示すように、必要に応じて、@type属性の要求オブジェクトを定義することができます。

{
  "@type": "<request object>",
  "<attribute1>": "<value1>",
  "<attribute2>": "<value2>",
 }

属性にオブジェクトが含まれるときは、属性を示し、次のようにオブジェクト名を使用します。

{
  "@type": "<request object>",
  "<attribute1>": "<value1>",
  "<attribute2>": {
     "@type": "<attribute object>",
     "<attributeA>": "<valueA>",
     "<attributeB>": "<valueB>",}
     "@type": "<attribute object>",
     "<attributeD>": "<valueD>",
     "<attributeE>": "<valueE>",}
  "<attribute3>": "<value3>",
}

バージョン3 REST API呼び出しでは、@type属性を使用しないでください。

XML形式

XML形式を使用する場合は、次のように、要求オブジェクトをタグの包含セットとして定義します。

<request object>
   <attribute1>value1</attribute1>
   <attribute2>value2</attribute2>
</request object>

属性にオブジェクトが含まれるときは、次のように属性オブジェクトを属性タグ内に囲みます。

<request object>
   <attribute1>value1</attribute1>
   <attribute2>
     <attribute object>
       <attributeA>valueA</attributeA>
       <attributeB>valueB</attributeB>
     </attribute object>
     <attribute object>
       <attributeC>valueC</attributeC>
       <attributeD>valueD</attributeD>
     </attribute object>
   </attribute2>
   <attribute3>value3</attribute3>
</request object>

ヘッダーと本文の設定

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

要求本文

要求本文

JSON形式

XML形式