Chatter REST API 開発者ガイド
jfilterGroup
要求 URL またはリクエストボディで filterGroup パラメータを使用して、返されるプロパティのグループサイズ (Small、Medium、Big) を指定します。filterGroup プロパティは、API バージョン 29.0 以降で使用できます。
各レスポンスボディのすべてのプロパティにグループサイズが割り当てられます。
- Big — デフォルトのサイズです。レスポンスボディにすべてのプロパティ (Big、Medium、および Small のマークが付けられたプロパティ) が含まれます。
- Medium — Medium および Small のマークが付けられたプロパティが含まれます。
- Small — 最小の応答サイズです。Small のマークが付けられたプロパティのみが含まれます。
検索条件グループの使用について、次の事項を把握している必要があります。
- デフォルトの filterGroup サイズは Big です。
- プロパティに割り当てられる各検索条件グループサイズには、API バージョンがあります。今後、API バージョンのプロパティは、別の検索条件グループに移動する可能性があります。
- 検索条件グループは、DELETE と HEAD を除くすべての HTTP 動詞に影響します。
- 特に指定のない限り、バッチ要求のボディ内のサブ要求を含むすべての要求 URL で filterGroup パラメータを使用できます。
- filterGroup パラメータを include または exclude 条件パラメータと組み合わせて使用し、返されるプロパティのセットを変更できます。結果セットは、2 つのセットの結合です。
filterGroup パラメータと、include または exclude パラメータの併用
要求には、filterGroup パラメータ、グループサイズ値、include または exclude 条件パラメータ、URL の値を含めることができます。これは、汎用バッチ要求のサブ要求にも該当します。
要求 (またはサブ要求) に filterGroup と include の両方のパラメータがあると、include パラメータで指定されたプロパティが常に応答に含まれます。
要求 (またはサブ要求) に filterGroup と exclude の両方のパラメータがあると、exclude パラメータで指定されたプロパティが常に応答から除外されます。
次の表の行を左から右に読んでいき、応答にプロパティが含まれているかどうかを確認します。
| 要求に include 条件がある | 要求の include 条件にプロパティがある | 要求に exclude 条件がある | 要求の exclude 条件にプロパティがある | 要求に filterGroup がある | 要求の filterGroup にプロパティがある | 応答にプロパティがある |
|---|---|---|---|---|---|---|
| はい | いいえ | いいえ | いいえ | いいえ | いいえ | いいえ |
| はい | はい | いいえ | いいえ | はい/いいえ | はい/いいえ | はい |
| いいえ | いいえ | はい | いいえ | いいえ | いいえ | はい |
| いいえ | いいえ | はい | いいえ | はい | いいえ | いいえ |
| いいえ | いいえ | はい | はい | はい/いいえ | はい/いいえ | いいえ |
| いいえ | いいえ | いいえ | いいえ | はい | いいえ | いいえ |
| いいえ | いいえ | いいえ | いいえ | はい | はい | はい |
| はい | はい/いいえ | はい | はい/いいえ | はい/いいえ | はい/いいえ | エラー (400) |
例
この例では、User Profile リソースの Small レスポンスボディを取得します。
1GET /chatter/users/me?filterGroup=Small次にレスポンスボディを示します。
1{
2 "companyName": "Universal Containers",
3 "firstName": "Deanna",
4 "hasChatter": true,
5 "id": "005D0000001LL8OIAW",
6 "isActive": true,
7 "isInThisCommunity": true,
8 "lastName": "Li",
9 "motif": {
10 "color": "1797C0",
11 "largeIconUrl": "/img/icon/profile64.png",
12 "mediumIconUrl": "/img/icon/profile32.png",
13 "smallIconUrl": "/img/icon/profile16.png"
14 },
15 "name": "Deanna Li",
16 "photo": {
17 "photoVersionId": "729D00000000LJFIA2",
18 "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
19 "standardEmailPhotoUrl": "https://instance_name/ncsphoto
20 /SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sYVo6fntPnCQ_-xIH-GU3vI",
21 "url": "/services/data/v37.0/chatter/users/005D0000001LL8OIAW/photo"
22 },
23 "title": null,
24 "type": "User",
25 "url": "/services/data/v37.0/chatter/users/005D0000001LL8OIAW",
26 "username": "dli@uc.com"
27}