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