Chatter REST API 開発者ガイド
jexclude
特定のプロパティをレスポンスボディから除外するには、exclude 要求パラメータを使用します。exclude パラメータは、API バージョン 27.0 以降で使用できます。
exclude クエリの値は、バー (|) で区切られたプロパティのリストです。URL は、バーを %7C として符号化します。各プロパティ名の前にスラッシュを含める必要があります。
次の要求は、aboutMe プロパティと address プロパティをレスポンスボディから除外します。
次の表に、exclude クエリパラメータの使用ルールおよびその他の例を示します。
| 説明 | 元の出力 | Exclude の値 | 絞り込み後の出力 |
|---|---|---|---|
| プロパティ名の前にスラッシュ (/) を含めないと、要求からエラーが返されます。 |
|
exclude=bar | エラーコード INVALID_FILTER_VALUE の 400 エラー |
| プロパティを名前で絞り込みます。 |
|
exclude=/bar |
|
| 最上位レベルのプロパティは絞り込みできません。このクエリ文字列はエラーを返しません。 |
|
exclude=/foo |
|
| 複数のプロパティを絞り込むには、バー (|) 区切り文字を使用します。URL は、区切り文字を %7C として符号化します。 |
|
exclude=/foo%7C/bar |
|
| レスポンスボディの絞り込みでは、レスポンスボディ内のすべてが絞り込まれます。 |
|
exclude=/someObject |
|
| レスポンスボディ内でネストされたプロパティを絞り込むには、親レスポンスボディの名前を条件セグメントとして含めます。 |
|
exclude=/someObject/sub |
|
| リスト内の項目は、プロパティ名で識別します。この例では XML を使用します。 |
|
exclude=/someList/item/id |
|
| リスト内の項目は、プロパティ名で識別します。この例では JSON を使用します。 |
|
exclude=/someList/item/id |
|