Group Memberships リソース

次のリソースを使用できます。

Group Memberships Information

グループのメンバーに関する情報へのアクセス、グループからのメンバーの削除、およびグループメンバーのロールの更新に使用されます。

メンバーシップ ID は /chatter/groups/groupId/memberships リソースから返されます。

リソース

1/chatter/group-memberships/membershipId

1/connect/communities/communityId/chatter/group-memberships/membershipId

適用開始バージョン

23.0

Chatter が必要かどうか

はい

HTTP メソッド

GET、DELETE、HEAD、PATCH

PATCH は 29.0 でサポート

PATCH のリクエストボディ

ルート XML タグ

<member>

JSON の例

1{   
2    "role" : "GroupManager",
3    "userId" : "005B0000000Ge16"
4}

プロパティ

名前	型	説明	使用可能なバージョン
role	String	メンバーのロール。次のいずれかの値にします。 GroupManager StandardMember	29.0
userId	String	グループに追加するメンバーのユーザ ID。	23.0

PATCH 要求でグループメンバーのロールを更新するには、userId プロパティは渡さずに role プロパティのみを渡します。

メモ

PATCH の要求パラメータ

名前	型	説明	使用可能なバージョン
role	String	メンバーのロール。次のいずれかの値にします。 GroupManager StandardMember	29.0

GET または PATCH のレスポンスボディ

Group Member

Batch Group Memberships

グループメンバーのリストに関する情報へのアクセスに使用されます。メンバーは同じグループに属す必要はありません。各メンバーシップ ID は、特定のグループに関連付けられています。

メンバーシップ ID は、複数の groups リソースのレスポンスボディで返されます。

1/chatter/groups/groupId/members

リソース

1/chatter/group-memberships/batch/membershipIds

1/connect/communities/communityId/chatter/group-memberships/batch/membershipIds

membershipIds は、最大 500 個のメンバーシップ ID から成るカンマ区切りのリストです。

適用開始バージョン

27.0

Chatter が必要かどうか

はい

HTTP メソッド

GET、HEAD

GET または HEAD のレスポンスボディ

Batch Results

GET の例

次の要求は、2 人のユーザのグループメンバーシップ情報を取得します。

1/chatter/group-memberships/batch/0FBD00000003GAPOA2,0FBD00000003GAKOA

これは、ネストされた User Summary レスポンスボディを含む Batch Results レスポンスボディです。

1{
2   "hasErrors": true,
3   "results": [
4      {
5         "result": {
6            "id": "0FBD00000003GAPOA2",
7            "role": "StandardMember",
8            "url": "/services/data/v38.0/chatter/group-memberships/0FBD00000003GAPOA2",
9            "user": {
10               "companyName": "Universal Containers",
11               "firstName": "Gordon",
12               "id": "005D0000001LLO1IAO",
13               "isActive": true,
14               "isInThisCommunity": true,
15               "lastName": "Johnson",
16               "motif": {
17                  "color": "1797C0",
18                  "largeIconUrl": "/img/icon/profile64.png",
19                  "mediumIconUrl": "/img/icon/profile32.png",
20                  "smallIconUrl": "/img/icon/profile16.png"
21               },
22               "mySubscription": {
23                  "id": "0E8D0000000T5ZUKA0",
24                  "url": "/services/data/v38.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
25               },
26               "name": "Gordon Johnson",
27               "photo": {
28                  "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC",
29                  "largePhotoUrl": "https:/instance_name/profilephoto/729D00000000LJL/F",
30                  "photoVersionId": "729D00000000LJLIA2",
31                  "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
32                  "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O",
33                  "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO/photo"
34               },
35               "title": "VP Sales",
36               "type": "User",
37               "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO",
38               "userType": "Internal"
39            }
40         },
41         "statusCode": 200
42      },
43      {
44         "result": [{
45            "errorCode": "NOT_FOUND",
46            "message": "The requested resource does not exist"
47         }],
48         "statusCode": 404
49      }
50   ]
51}

2 つ目のグループメンバーシップが見つかっていません。バッチ要求は、サブ要求ごとの状況コードを返します。