この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

include

レスポンスボディを特定のプロパティに限定するには、include クエリ文字列パラメーターを使用します。

include クエリ文字列パラメーターの値は、バー (|) で区切られたプロパティのリストです。URL は、バーを %7C として符号化します。各プロパティ名の前にスラッシュを含めます。

次の要求では、aboutMe プロパティと address プロパティのみがレスポンスボディに含まれます。
1/chatter/users/me?include=/aboutMe%7C/address

次の表に、include クエリパラメーターの使用ルールを示します。

説明 元の出力 Include の値 絞り込み後の出力
プロパティ名の前にスラッシュ (/) を含めないと、要求からエラーが返されます。
1{
2 "bar" : "bar value",
3 "baz" : "baz value"
4}
include=bar エラーコード INVALID_FILTER_VALUE の 400 エラー
プロパティを名前で絞り込みます。
1{
2 "bar" : "bar value",
3 "baz" : "baz value"
4}
include=/bar
1{
2 "bar" : "bar 
3value",
4}
最上位レベルのプロパティは無視されます。この操作を行っても、エラーにはなりません。
1<foo>
2 <bar>bar value</bar>
3 <baz>baz value</baz>
4</foo>
include=/foo
1<foo>
2  <bar>bar value
3  </bar>
4  <baz>baz value
5  </baz>
6</foo>
複数のプロパティを絞り込むには、バー (|) 区切り文字を使用します。URL は、区切り文字を %7C として符号化します。
1{
2 "foo" : "foo value",
3 "bar" : "bar value",
4 "baz" : "baz value"
5}
include=/foo%7C/bar
1{
2  "foo" : "foo 
3value",
4  "bar" : "bar 
5value",
6}
レスポンスボディの絞り込みでは、その下にあるすべてのものが絞り込まれます。
1<foo>
2 <bar>bar value</bar>
3 <baz>baz value</baz>
4 <someObject>
5   <sub>sub 1</sub>
6 </someObject>
7</foo>
include=/someObject
1<foo>
2  <someObject>
3    <sub>sub 1
4    </sub>
5  </someObject>
6</foo>
レスポンスボディ内でネストされたプロパティを絞り込むには、親レスポンスボディの名前を条件セグメントとして含めます。
1<foo>
2 <bar>bar value</bar>
3 <baz>baz value</baz>
4 <someObject>
5   <sub>sub value</sub>
6  </someObject>
7</foo>
include=/someObject/sub
1<foo>
2  <someObject>
3   <sub>sub 1
4   </sub>
5  </someObject>
6</foo>
リスト内の項目は、プロパティ名で識別します。この例では XML を使用します。
1<foo>
2 <bar>bar valu</bar>
3 <baz>baz value</baz>
4 <someList>
5   <item>
6     <id>1</id>
7   </item>
8   <item>
9     <id>2</id>
10   </item>
11   <item>
12     <id>3</id>
13   </item>
14 </someList>
15</foo>
include=/someList/item/id
1<foo>
2 <someList>
3   <item>
4    <id>1</id>
5   </item>
6   <item>
7     <id>2</id>
8   </item>
9   <item>
10     <id>3</id>
11   </item>
12  </someList> 
13</foo>
リスト内の項目は、プロパティ名で識別します。この例では JSON を使用します。
1{
2 "bar" : "bar value",
3 "baz" : "baz value",
4 "someList" : [
5   {
6     "id" : "1"
7   },
8   {
9     "id" : "2"
10   } ,
11   {
12     "id" : "3"
13   } 
14 ]
15}
include=/someList/item/id
1{
2 "someList" : [
3   {
4     "id" : "1"
5   },
6   {
7     "id" : "2"
8   } ,
9   {
10     "id" : "3"
11   } 
12 ] 
13}