Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "body": {
// "messageSegments": [
// {
// "type": "Text",
// "text": "Editing a comment"
// }
// ]
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("body.messageSegments[0].type","Text")
loJson.UpdateString("body.messageSegments[0].text","Editing a comment")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("GET","https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "body": {
// "isRichText": true,
// "messageSegments": [
// {
// "altText": null,
// "htmlTag": "p",
// "markupType": "Paragraph",
// "text": "",
// "type": "MarkupBegin",
// "url": null
// },
// {
// "text": "Comment",
// "type": "Text"
// },
// {
// "htmlTag": "p",
// "markupType": "Paragraph",
// "text": "\n",
// "type": "MarkupEnd"
// }
// ],
// "text": "Comment\n"
// },
// "capabilities": {
// "edit": {
// "isEditRestricted": false,
// "isEditableByMeUrl": "/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me",
// "lastEditedBy": null,
// "lastEditedDate": null,
// "latestRevision": 1,
// "relativeLastEditedDate": null
// },
// "status": {
// "feedEntityStatus": "Published",
// "isApprovableByMe": true
// },
// "upDownVote": {
// "downVoteCount": 0,
// "myVote": "None",
// "upVoteCount": 0
// },
// "verified": {
// "isVerifiableByMe": false,
// "isVerified": false,
// "isVerifiedByAnonymized": null,
// "lastVerifiedByUser": null,
// "lastVerifiedDate": null
// }
// },
// "clientInfo": null,
// "createdDate": "2023-11-22T11:19:50.000Z",
// "feedElement": {
// "id": "0D5...",
// "url": "/services/data/v58.0/chatter/feed-elements/0D5..."
// },
// "id": "0D7...",
// "isDeleteRestricted": false,
// "likes": {
// "currentPageToken": null,
// "currentPageUrl": "/services/data/v58.0/chatter/comments/0D7.../likes",
// "items": [
// ],
// "nextPageToken": null,
// "nextPageUrl": null,
// "previousPageToken": null,
// "previousPageUrl": null,
// "total": 0
// },
// "likesMessage": null,
// "moderationFlags": null,
// "myLike": null,
// "parent": {
// "id": "005...",
// "url": "/services/data/v58.0/chatter/users/005..."
// },
// "relativeCreatedDate": "Just now",
// "threadLevel": 0,
// "threadParentId": null,
// "type": "TextComment",
// "url": "/services/data/v58.0/chatter/comments/0D7...",
// "user": {
// "additionalLabel": null,
// "communityNickname": "User1696423780773910041",
// "companyName": "Salesforce",
// "displayName": "Name",
// "firstName": "Firstname",
// "id": "005...",
// "isActive": true,
// "isInThisCommunity": true,
// "lastName": "Name",
// "motif": {
// "color": "1B96FF",
// "largeIconUrl": "/img/icon/profile64.png",
// "mediumIconUrl": "/img/icon/profile32.png",
// "smallIconUrl": "/img/icon/profile16.png",
// "svgIconUrl": null
// },
// "mySubscription": null,
// "name": "Name",
// "outOfOffice": {
// "message": ""
// },
// "photo": {
// "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/729.../F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/729.../M",
// "photoVersionId": "729...",
// "smallPhotoUrl": "https://<my_domain>/profilephoto/729.../T",
// "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// },
// "reputation": null,
// "title": null,
// "type": "User",
// "url": "/services/data/v58.0/chatter/users/005...",
// "userType": "Internal"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
llIsRichText = loJResp.BoolOf("body.isRichText")
lcText = loJResp.StringOf("body.text")
llIsEditRestricted = loJResp.BoolOf("capabilities.edit.isEditRestricted")
lcIsEditableByMeUrl = loJResp.StringOf("capabilities.edit.isEditableByMeUrl")
lcLastEditedBy = loJResp.StringOf("capabilities.edit.lastEditedBy")
lcLastEditedDate = loJResp.StringOf("capabilities.edit.lastEditedDate")
lnLatestRevision = loJResp.IntOf("capabilities.edit.latestRevision")
lcRelativeLastEditedDate = loJResp.StringOf("capabilities.edit.relativeLastEditedDate")
lcFeedEntityStatus = loJResp.StringOf("capabilities.status.feedEntityStatus")
llIsApprovableByMe = loJResp.BoolOf("capabilities.status.isApprovableByMe")
lnDownVoteCount = loJResp.IntOf("capabilities.upDownVote.downVoteCount")
lcMyVote = loJResp.StringOf("capabilities.upDownVote.myVote")
lnUpVoteCount = loJResp.IntOf("capabilities.upDownVote.upVoteCount")
llIsVerifiableByMe = loJResp.BoolOf("capabilities.verified.isVerifiableByMe")
llIsVerified = loJResp.BoolOf("capabilities.verified.isVerified")
lcIsVerifiedByAnonymized = loJResp.StringOf("capabilities.verified.isVerifiedByAnonymized")
lcLastVerifiedByUser = loJResp.StringOf("capabilities.verified.lastVerifiedByUser")
lcLastVerifiedDate = loJResp.StringOf("capabilities.verified.lastVerifiedDate")
lcClientInfo = loJResp.StringOf("clientInfo")
lcCreatedDate = loJResp.StringOf("createdDate")
lcId = loJResp.StringOf("feedElement.id")
lcV_Url = loJResp.StringOf("feedElement.url")
lcId = loJResp.StringOf("id")
llIsDeleteRestricted = loJResp.BoolOf("isDeleteRestricted")
lcCurrentPageToken = loJResp.StringOf("likes.currentPageToken")
lcCurrentPageUrl = loJResp.StringOf("likes.currentPageUrl")
lcNextPageToken = loJResp.StringOf("likes.nextPageToken")
lcNextPageUrl = loJResp.StringOf("likes.nextPageUrl")
lcPreviousPageToken = loJResp.StringOf("likes.previousPageToken")
lcPreviousPageUrl = loJResp.StringOf("likes.previousPageUrl")
lnTotal = loJResp.IntOf("likes.total")
lcLikesMessage = loJResp.StringOf("likesMessage")
lcModerationFlags = loJResp.StringOf("moderationFlags")
lcMyLike = loJResp.StringOf("myLike")
lcParentId = loJResp.StringOf("parent.id")
lcParentUrl = loJResp.StringOf("parent.url")
lcRelativeCreatedDate = loJResp.StringOf("relativeCreatedDate")
lnThreadLevel = loJResp.IntOf("threadLevel")
lcThreadParentId = loJResp.StringOf("threadParentId")
lcV_type = loJResp.StringOf("type")
lcUrl = loJResp.StringOf("url")
lcAdditionalLabel = loJResp.StringOf("user.additionalLabel")
lcCommunityNickname = loJResp.StringOf("user.communityNickname")
lcCompanyName = loJResp.StringOf("user.companyName")
lcDisplayName = loJResp.StringOf("user.displayName")
lcFirstName = loJResp.StringOf("user.firstName")
lcUserId = loJResp.StringOf("user.id")
llIsActive = loJResp.BoolOf("user.isActive")
llIsInThisCommunity = loJResp.BoolOf("user.isInThisCommunity")
lcLastName = loJResp.StringOf("user.lastName")
lcColor = loJResp.StringOf("user.motif.color")
lcLargeIconUrl = loJResp.StringOf("user.motif.largeIconUrl")
lcMediumIconUrl = loJResp.StringOf("user.motif.mediumIconUrl")
lcSmallIconUrl = loJResp.StringOf("user.motif.smallIconUrl")
lcSvgIconUrl = loJResp.StringOf("user.motif.svgIconUrl")
lcMySubscription = loJResp.StringOf("user.mySubscription")
lcName = loJResp.StringOf("user.name")
lcMessage = loJResp.StringOf("user.outOfOffice.message")
lcFullEmailPhotoUrl = loJResp.StringOf("user.photo.fullEmailPhotoUrl")
lcLargePhotoUrl = loJResp.StringOf("user.photo.largePhotoUrl")
lcMediumPhotoUrl = loJResp.StringOf("user.photo.mediumPhotoUrl")
lcPhotoVersionId = loJResp.StringOf("user.photo.photoVersionId")
lcSmallPhotoUrl = loJResp.StringOf("user.photo.smallPhotoUrl")
lcStandardEmailPhotoUrl = loJResp.StringOf("user.photo.standardEmailPhotoUrl")
lcPhotoUrl = loJResp.StringOf("user.photo.url")
lcReputation = loJResp.StringOf("user.reputation")
lcTitle = loJResp.StringOf("user.title")
lcV_Type = loJResp.StringOf("user.type")
lcUserUrl = loJResp.StringOf("user.url")
lcUserType = loJResp.StringOf("user.userType")
i = 0
lnCount_i = loJResp.SizeOfArray("body.messageSegments")
do while i < lnCount_i
loJResp.I = i
lcAltText = loJResp.StringOf("body.messageSegments[i].altText")
lcHtmlTag = loJResp.StringOf("body.messageSegments[i].htmlTag")
lcMarkupType = loJResp.StringOf("body.messageSegments[i].markupType")
lcText = loJResp.StringOf("body.messageSegments[i].text")
lcV_type = loJResp.StringOf("body.messageSegments[i].type")
lcUrl = loJResp.StringOf("body.messageSegments[i].url")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("likes.items")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Editing a comment"
}
]
}
}'
https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID
Postman Collection Item JSON
{
"name": "Comment",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {},
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"comments",
":COMMENT_ID"
],
"variable": [
{
"key": "COMMENT_ID",
"value": "0D7..."
}
]
},
"description": "Get information about, edit, or delete a comment.\nTo post a comment, use Feed Elements Capability, Comments Items.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_comments_specific.htm#connect_resources_comments_specific"
},
"response": [
{
"name": "Successful Comment",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"comments",
":COMMENT_ID"
],
"variable": [
{
"key": "COMMENT_ID",
"value": "0D72o00000E8dNiCAJ"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:20:42 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"body\": {\n \"isRichText\": true,\n \"messageSegments\": [\n {\n \"altText\": null,\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \"Comment\",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\\n\",\n \"type\": \"MarkupEnd\"\n }\n ],\n \"text\": \"Comment\\n\"\n },\n \"capabilities\": {\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n },\n \"verified\": {\n \"isVerifiableByMe\": false,\n \"isVerified\": false,\n \"isVerifiedByAnonymized\": null,\n \"lastVerifiedByUser\": null,\n \"lastVerifiedDate\": null\n }\n },\n \"clientInfo\": null,\n \"createdDate\": \"2023-11-22T11:19:50.000Z\",\n \"feedElement\": {\n \"id\": \"0D5...\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\"\n },\n \"id\": \"0D7...\",\n \"isDeleteRestricted\": false,\n \"likes\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/comments/0D7.../likes\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n },\n \"likesMessage\": null,\n \"moderationFlags\": null,\n \"myLike\": null,\n \"parent\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"relativeCreatedDate\": \"Just now\",\n \"threadLevel\": 0,\n \"threadParentId\": null,\n \"type\": \"TextComment\",\n \"url\": \"/services/data/v58.0/chatter/comments/0D7...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}"
}
]
}
