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

Chatter REST API 開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

exclude

特定のプロパティをレスポンスボディから除外するには、exclude 要求パラメータを使用します。exclude パラメータは、API バージョン 27.0 以降で使用できます。

exclude クエリの値は、バー (|) で区切られたプロパティのリストです。URL は、バーを %7C として符号化します。各プロパティ名の前にスラッシュを含める必要があります。

次の要求は、aboutMe プロパティと address プロパティをレスポンスボディから除外します。
1/chatter/users/me?exclude=/aboutMe%7C/address
次の表に、exclude クエリパラメータの使用ルールおよびその他の例を示します。
説明 元の出力 Exclude の値 絞り込み後の出力
プロパティ名の前にスラッシュ (/) を含めないと、要求からエラーが返されます。 
1{
2 "bar" : "bar value",
3 "baz" : "baz value"
4}
 exclude=bar エラーコード INVALID_FILTER_VALUE の 400 エラー
プロパティを名前で絞り込みます。 
1{
2 "bar" : "bar value",
3 "baz" : "baz value"
4}
 exclude=/bar 
1{
2 "baz" : "baz 
3value"
4}
最上位レベルのプロパティは絞り込みできません。このクエリ文字列はエラーを返しません。 
1<foo>
2 <bar>bar value</bar>
3 <baz>baz value</baz>
4</foo>
 exclude=/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}
 exclude=/foo%7C/bar 
1{
2 "baz" : "baz 
3value"
4}
レスポンスボディの絞り込みでは、レスポンスボディ内のすべてが絞り込まれます。 
1<foo>
2 <bar>bar value</bar>
3 <baz>baz value</baz>
4 <someObject>
5   <sub>sub 1</sub>
6 </someObject>
7</foo>
 exclude=/someObject 
1<foo>
2 <bar>bar value
3</bar>
4 <baz>baz value
5 </baz>
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>
 exclude=/someObject/sub 
1<foo>
2 <bar>bar value
3 </bar>
4 <baz>baz value
5 </baz>
6 <someObject>
7 </someObject>
8</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>
 exclude=/someList/item/id 
1<foo>
2 <bar>bar value
3 </bar>
4 <baz>baz value
5 </baz>
6 <someList>
7   <item/>
8   <item/>
9   <item/>
10 </someList>
11</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}
 exclude=/someList/item/id 
1{
2 "bar" : "bar value",
3 "baz" : "baz value",
4 "someList" : [
5   {},
6   {},
7   {}
8 ]
9}