Connect REST API 開発者ガイド
jHTTP 要求フローおよびレスポンスボディ
Connect REST API のプロセスフロー (リソースおよび応答の例を含む) について確認します。
Connect REST API を使用するための一般的なプロセスフローは次のようになります。
- HTTP 要求を Salesforce に送信します。
- システムがユーザとクライアントアプリケーションを認証します。
- HTTP 要求を使用して Connect REST API リソースを要求します。
- システムが HTTP 戻りコードを返します。追加の情報 (Connect REST API レスポンスボディなど) は、必要に応じて応答に含まれます。
Connect REST API の各リソースは、HTTP メソッド (GET、POST、DELETE、HEAD など) で使用される URI です。各リソースは、ユーザのニュースフィードや投稿へのコメントなど、Salesforce 内のものを表します。
リソースの多くは、指定されたユーザ ID またはキーワード me を使用して現在のコンテキストユーザを示します。たとえば、現在のコンテキストユーザのユーザプロファイル情報を返すには、次のリソースを使用します。
1/chatter/users/meユーザ ID で特定のユーザを指定することもできます。
1/chatter/users/005D0000001GLoh正常にリソースにアクセスすると、JSON または XML でレスポンスボディが返されます。デフォルトでは、JSON が返されます。各レスポンスボディに 1 つ以上のレスポンスボディ項目が含まれることがあります。たとえば、ユーザリソースのレスポンスボディは次のようになります。これには、住所 (address)、現在の状況 (currentStatus)、電話番号 (phoneNumbers) など、他のレスポンスボディも含まれています。
| プロパティ | 型 | 説明 | 検索条件グループとバージョン | 使用可能なバージョン |
|---|---|---|---|---|
| aboutMe | String | ユーザのプロファイルから取得したテキスト。 | Big、29.0 | 23.0 |
| additionalLabel | String | ユーザの追加表示ラベル (存在する場合)。たとえば、「顧客」、「パートナー」、「Acme Corporation」などがあります。 | Small、30.0 | 30.0 |
| address | Address | ユーザの住所。 | Big、29.0 | 23.0 |
| bannerPhoto | Banner Photo | ユーザのバナー写真。 | Big、36.0 | 36.0 |
| chatterActivity | Chatter Activity | Chatter 活動統計。 | Big、29.0 | 23.0 |
| chatterInfluence | Chatter Influence | ユーザの影響度ランク。 | Big、29.0 | 23.0 |
| communityNickname | String | サイトでのユーザのニックネーム。 | Medium、32.0 | 32.0 |
| companyName | String | 会社名。 | Small、29.0 | 23.0 |
| currentStatus | User Status | ユーザの現在の状況。 | 23.0 ～ 25.0 | |
| displayName | String | サイトで表示されるユーザの名前。ニックネームが有効な場合は、ニックネームが表示されます。ニックネームが有効ではない場合は、氏名が表示されます。 | Small、32.0 | 32.0 |
| String | ユーザのメールアドレス。 | Medium、29.0 | 23.0 | |
| firstName | String | ユーザの名。バージョン 39.0 以降では、ニックネームが有効な場合、firstName は null になります。 | Small、29.0 | 23.0 |
| followersCount | Integer | このユーザをフォローしているユーザの数。 | Big、29.0 | 23.0 |
| followingCounts | Following Counts | ユーザがフォローしている項目に関する情報。 | Big、29.0 | 23.0 |
| groupCount | Integer | ユーザがフォローしているグループの数。 | Big、29.0 | 23.0 |
| hasChatter | Boolean | ユーザに Chatter へのアクセス権がある場合は true、それ以外の場合は false。 | Small、31.0 | 31.0 |
| id | String | ユーザの 18 文字の ID。 | Small、29.0 | 23.0 |
| isActive | Boolean | ユーザが有効な場合は true、それ以外の場合は false。 | Small、29.0 | 23.0 |
| isChatterGuest | Boolean | ユーザが Chatter 顧客の場合は true、それ以外の場合は false。 バージョン 26.0 以降では、userType プロパティを使用します。 |
23.0 ～ 25.0 | |
| isInThisCommunity | Boolean | ユーザがコンテキストユーザと同じ Experience Cloud サイトに含まれる場合は true、それ以外の場合は false。範囲が「すべてのユーザ」の投稿に対するレコードフィードの @メンションの場合、false になることがあります。 | Small、29.0 | 28.0 |
| lastName | String | ユーザの姓。バージョン 39.0 以降では、ニックネームが有効な場合、lastName は null になります。 | Small、29.0 | 23.0 |
| managerId | String | ユーザのマネージャの 18 文字の ID。 | Big、29.0 | 23.0 |
| managerName | String | ロケールに基づいて連結されたマネージャの姓と名。 | Big、29.0 | 23.0 |
| motif | Motif | オブジェクトがユーザであることを示す小、中、大のアイコン。motif にはオブジェクトのベース色を含めることもできます。 motif アイコンは、ユーザのプロファイル写真ではありません。 |
Small、29.0 | 27.0 |
| mySubscription | Reference | コンテキストユーザがこのユーザをフォローしている場合は、登録に関する情報が含まれます。それ以外の場合は、null。 | Medium、29.0 | 23.0 |
| name | String | ロケールに基づいて連結された姓と名。バージョン 39.0 以降では、ニックネームが有効な場合、name はニックネームになります。 | Small、29.0 | 23.0 |
| outOfOffice | Out of Office | ユーザの別途の外出中メッセージ (存在する場合)。 | Small、40.0 | 40.0 |
| phoneNumbers | Phone Number[] | ユーザの電話番号のコレクション。 | Big、29.0 | 23.0 |
| photo | Photo | ユーザの写真に関する情報。 | Small、29.0 | 23.0 |
| reputation | Reputation | サイトでのユーザの評価。サイトで実行したイベントやアクションを基に獲得したポイント数によって判断されます。 | Big、32.0 | 32.0 |
| stamps | Stamp[] | ユーザのスタンプのコレクション。 バージョン 44.0 以降では、SOQL を使用してユーザのスタンプを取得します。 |
Small、39.0 | 39.0 ～ 43.0 |
| thanksReceived | Integer | ユーザが受け取った感謝の数。 | Big、29.0 | 29.0 |
| title | String | ユーザの役職。 | Small、29.0 | 23.0 |
| type | String | 値は User です。 | Small、29.0 | 23.0 |
| url | String | ユーザの Chatter プロファイルへの URL。 | Small、29.0 | 23.0 |
| username | String | ユーザのユーザ名 (Admin@mycompany.com など)。 | Small、29.0 | 24.0 |
| userType | String | ユーザの種別。有効な値は、次のとおりです。
|
Medium、29.0 | 26.0 |
JSON 形式では、出力は次のようになります。
1{
2 "aboutMe": "I'm excited to be part of the team focused on building out our apps business
3 and showing our customers their future.",
4 "additionalLabel" : null,
5 "address": {
6 "city": "Seattle",
7 "country": "US",
8 "state": "WA",
9 "street": "2001 8th Ave",
10 "zip": "98121"
11 "formattedAdress": "2001 8th Ave\nSeattle, WA 98121\nUS"
12 },
13 "chatterActivity": {
14 "commentCount": 0,
15 "commentReceivedCount": 1,
16 "likeReceivedCount": 0,
17 "postCount": 2
18 },
19 "chatterInfluence" : {
20 "percentile" : "0.6666666666666667",
21 "rank" : 1
22 },
23 "communityNickname": "marRave",
24 "companyName": "Seattle Apps",
25 "displayName": "Marion Raven",
26 "email": "mraven@seattleapps.com",
27 "firstName": "Marion",
28 "followersCount": 1,
29 "followingCounts": {
30 "people": 5,
31 "records": 0,
32 "total": 5
33 },
34 "groupCount": 3,
35 "hasChatter": true,
36 "id": "005D0000001Kl6xIAC",
37 "isActive": true,
38 "isInThisCommunity" : true,
39 "lastName": "Raven",
40 "managerId": null,
41 "managerName": null,
42 "motif": {
43 "color" : "20aeb8",
44 "largeIconUrl": "/img/icon/profile64.png",
45 "mediumIconUrl": "/img/icon/profile32.png",
46 "smallIconUrl": "/img/icon/profile16.png"
47 },
48 "mySubscription": null,
49 "name": "Marion Raven",
50 "phoneNumbers": [{
51 "label": "Work",
52 "phoneNumber": "(206) 999-2846",
53 "phoneType": "Work"
54 }],
55 "photo": {
56 "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
57 "largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
58 "photoVersionId": "729D00000000BDV",
59 "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
60 "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
61 "url": "/services/data/v59.0/chatter/users/005D0000001LL8OIAW/photo"
62 },
63 "reputation" : null,
64 "thanksReceived" : null,
65 "title": null,
66 "type": "User",
67 "url": "/services/data/v59.0/chatter/users/005D0000001Kl6xIAC",
68 "userType": "Internal";
69 "username": "mraven@seattleapps.com"
70}