Feed Elements Capability, Comments Items

コメントに添付するバイナリファイルをアップロードするには、マルチパート/フォームデータ要求に含めて送信する必要があります。コメントのテキストを送信するには、マルチパート/フォームデータ要求に JSON または XML リッチ入力ボディパートを含める方法があります。または、その情報を要求パラメーターパートで渡すように選択することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してく��さい。

リソース

1/chatter/feed-elements/feedElementId/capabilities/comments/items

1/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/comments/items

使用可能なバージョン

32.0

Chatter が必要かどうか

はい

HTTP のメソッド

GET、POST

GET の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
page	String	ページの表示に使用するページトークン。Comment Page の nextPageUrl プロパティの値を使用します。	省略可能	32.0
pageSize	Integer	ページあたりのコメント数。デフォルト値は 3 です。	省略可能	32.0
sort	String	コメントの順序。値は次のとおりです。 CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。 CreatedDateOldestAsc — コメントを古い順に並べ替えます。 Relevance — 最も関連性の高いコンテンツで並べ替えます。 デフォルト値は、CreatedDateLatestAsc です。 降順で並べ替えはサポートされません。	省略可能	44.0
threaded​Comments​Collapsed	Boolean	折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。指定しない場合、デフォルトは false です。	省略可能	44.0

GET のレスポンスボディ

Comment Page

フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。

POST のリクエストボディ

ルート XML タグ

<comment>

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
attachment	種別によって異なる。	値は次のとおりです。 Attachment Input: Existing Content Attachment Input: New File Upload バージョン 32.0 以降では、capabilities プロパティを使用します。 重要	省略可能	24.0 ～ 31.0
body	Message Body Input	コメントの本文。 フィード項目とコメントの本文には、最大 10,000 文字まで含めることができます。この制限は変更可能なため、クライアントが FeedItem または FeedComment オブジェクトで describeSObjects() コールを実行することをお勧めします。最大許容文字数を判断するには、Body または CommentBody 項目の長さを見ます。 コメントのこのプロパティを編集するには、/chatter/comments/commentId に対して PATCH 要求を実行します。コメントの編集は、バージョン 34.0 以降でサポートされています。 バージョン 35.0 以降では、リッチテキストとインライン画像がコメント本文でサポートされます。エンティティリンクはバージョン 43.0 以降でサポートされています。	必須	23.0
capabilities	Comment Capabilities Input	添付ファイルなど、コメントの機能。 コメントの本文は編集できますが、コメントの機能は更新できません。	省略可能	32.0
threadParentId	String	スレッドコメントの親コメントの ID。	省略可能	44.0

POST の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
text	String	コメントのテキスト。	必須	32.0

POST のレスポンスボディ

Comment

フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。

リクエストボディを使用してコメントを投稿する例

1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"New comment"
7         }
8      ]
9   }
10}

リクエストボディを使用してメンションを含むコメントを投稿する例

1{ "body" : 
2   { 
3      "messageSegments" : [ 
4         { 
5           "type": "mention", 
6           "id" : "005D0000001GpHp" 
7         },
8         { 
9           "type": "text", 
10           "text" : " Did you see the new plans?" 
11         }
12      ]
13   }
14}

リクエストボディを使用して複数のメンションを含むコメントを投稿する例

1{ "body" : 
2   {
3      "messageSegments" : [ 
4          {
5            "type": "mention",
6            "id":"005D0000001LL8YIAW"
7          },
8          {
9            "type" : "Text",
10            "text" : " "
11         },
12          {
13            "type": "mention",
14            "id":"005D0000001LL8sIAG"
15          },
16          {
17             "type": "text",
18             "text":" Did you see the new plans?"
19          }
20      ]
21   }
22}

リクエストボディを使用してファイルが添付されたコメントを投稿する例

1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"Please take a look at this file."
7         }
8      ]
9   },
10   "capabilities":{
11      "content":{
12         "contentDocumentId":"069D00000001pyS"
13      }
14   }
15}

リクエストボディを使用してリッチテキストのコメントを投稿する例

1{
2   "body":{
3      "messageSegments":[
4         {
5            "markupType" : "Paragraph",
6            "type" : "MarkupBegin"
7         },
8         {
9            "markupType" : "Bold",
10            "type" : "MarkupBegin"
11         },
12         {
13             "text" : "First line of text.",
14             "type" : "Text"
15         },
16         {
17            "markupType" : "Bold",
18            "type" : "MarkupEnd"
19         },
20         {
21            "markupType" : "Paragraph",
22            "type" : "MarkupEnd"
23         },
24         {
25            "markupType" : "Paragraph",
26            "type" : "MarkupBegin"
27         },
28         {
29            "text" : " ",
30            "type" : "Text"
31         },
32         {
33            "markupType" : "Paragraph",
34            "type" : "MarkupEnd"
35         },
36         {
37            "markupType" : "Paragraph",
38            "type" : "MarkupBegin"
39         },
40         {
41            "text" : "Second line of text.",
42            "type" : "Text"
43         },
44         {
45            "markupType" : "Paragraph",
46            "type" : "MarkupEnd"
47         }
48      ]
49   }
50}

リクエストボディを使用してコードブロックを含むコメントを投稿する例

1{
2   "body":{
3      "messageSegments":[
4         {
5            "markupType" : "Code",
6            "type" : "MarkupBegin"
7         },
8         {
9             "text" : "<script>var i, t = 0;\nfor (i = 0; i < 5; i++) {\n   t +=
10                       i;\n}\n</script>",
11             "type" : "Text"
12         },
13         {
14            "markupType" : "Code",
15            "type" : "MarkupEnd"
16         }
17      ]
18   }
19}

リクエストボディを使用してインライン画像を含むコメントを投稿する例

1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"Please take a look at this file."
7         },
8         {
9            "type":"InlineImage",
10            "fileId":"069xx00000000QO",
11            "altText":"API Spec"
12         },
13         {
14            "type":"Text",
15            "text":"And this one."
16         },
17         {
18            "type":"InlineImage",
19            "fileId":"069xx00000000QT",
20            "altText":"REST API Spec"
21         }
22      ]
23   }
24}