Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; }
; ]
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"body.messageSegments[0].type","Text")
CkJsonObject::ckUpdateString(json,"body.messageSegments[0].text","Editing a comment")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"GET","https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
altText.s
htmlTag.s
markupType.s
text.s
IsRichText.i = CkJsonObject::ckBoolOf(jResp,"body.isRichText")
Text.s = CkJsonObject::ckStringOf(jResp,"body.text")
IsEditRestricted.i = CkJsonObject::ckBoolOf(jResp,"capabilities.edit.isEditRestricted")
IsEditableByMeUrl.s = CkJsonObject::ckStringOf(jResp,"capabilities.edit.isEditableByMeUrl")
LastEditedBy.s = CkJsonObject::ckStringOf(jResp,"capabilities.edit.lastEditedBy")
LastEditedDate.s = CkJsonObject::ckStringOf(jResp,"capabilities.edit.lastEditedDate")
LatestRevision.i = CkJsonObject::ckIntOf(jResp,"capabilities.edit.latestRevision")
RelativeLastEditedDate.s = CkJsonObject::ckStringOf(jResp,"capabilities.edit.relativeLastEditedDate")
FeedEntityStatus.s = CkJsonObject::ckStringOf(jResp,"capabilities.status.feedEntityStatus")
IsApprovableByMe.i = CkJsonObject::ckBoolOf(jResp,"capabilities.status.isApprovableByMe")
DownVoteCount.i = CkJsonObject::ckIntOf(jResp,"capabilities.upDownVote.downVoteCount")
MyVote.s = CkJsonObject::ckStringOf(jResp,"capabilities.upDownVote.myVote")
UpVoteCount.i = CkJsonObject::ckIntOf(jResp,"capabilities.upDownVote.upVoteCount")
IsVerifiableByMe.i = CkJsonObject::ckBoolOf(jResp,"capabilities.verified.isVerifiableByMe")
IsVerified.i = CkJsonObject::ckBoolOf(jResp,"capabilities.verified.isVerified")
IsVerifiedByAnonymized.s = CkJsonObject::ckStringOf(jResp,"capabilities.verified.isVerifiedByAnonymized")
LastVerifiedByUser.s = CkJsonObject::ckStringOf(jResp,"capabilities.verified.lastVerifiedByUser")
LastVerifiedDate.s = CkJsonObject::ckStringOf(jResp,"capabilities.verified.lastVerifiedDate")
clientInfo.s = CkJsonObject::ckStringOf(jResp,"clientInfo")
createdDate.s = CkJsonObject::ckStringOf(jResp,"createdDate")
Id.s = CkJsonObject::ckStringOf(jResp,"feedElement.id")
v_Url.s = CkJsonObject::ckStringOf(jResp,"feedElement.url")
id.s = CkJsonObject::ckStringOf(jResp,"id")
isDeleteRestricted.i = CkJsonObject::ckBoolOf(jResp,"isDeleteRestricted")
CurrentPageToken.s = CkJsonObject::ckStringOf(jResp,"likes.currentPageToken")
CurrentPageUrl.s = CkJsonObject::ckStringOf(jResp,"likes.currentPageUrl")
NextPageToken.s = CkJsonObject::ckStringOf(jResp,"likes.nextPageToken")
NextPageUrl.s = CkJsonObject::ckStringOf(jResp,"likes.nextPageUrl")
PreviousPageToken.s = CkJsonObject::ckStringOf(jResp,"likes.previousPageToken")
PreviousPageUrl.s = CkJsonObject::ckStringOf(jResp,"likes.previousPageUrl")
Total.i = CkJsonObject::ckIntOf(jResp,"likes.total")
likesMessage.s = CkJsonObject::ckStringOf(jResp,"likesMessage")
moderationFlags.s = CkJsonObject::ckStringOf(jResp,"moderationFlags")
myLike.s = CkJsonObject::ckStringOf(jResp,"myLike")
parentId.s = CkJsonObject::ckStringOf(jResp,"parent.id")
parentUrl.s = CkJsonObject::ckStringOf(jResp,"parent.url")
relativeCreatedDate.s = CkJsonObject::ckStringOf(jResp,"relativeCreatedDate")
threadLevel.i = CkJsonObject::ckIntOf(jResp,"threadLevel")
threadParentId.s = CkJsonObject::ckStringOf(jResp,"threadParentId")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
url.s = CkJsonObject::ckStringOf(jResp,"url")
AdditionalLabel.s = CkJsonObject::ckStringOf(jResp,"user.additionalLabel")
CommunityNickname.s = CkJsonObject::ckStringOf(jResp,"user.communityNickname")
CompanyName.s = CkJsonObject::ckStringOf(jResp,"user.companyName")
DisplayName.s = CkJsonObject::ckStringOf(jResp,"user.displayName")
FirstName.s = CkJsonObject::ckStringOf(jResp,"user.firstName")
userId.s = CkJsonObject::ckStringOf(jResp,"user.id")
IsActive.i = CkJsonObject::ckBoolOf(jResp,"user.isActive")
IsInThisCommunity.i = CkJsonObject::ckBoolOf(jResp,"user.isInThisCommunity")
LastName.s = CkJsonObject::ckStringOf(jResp,"user.lastName")
Color.s = CkJsonObject::ckStringOf(jResp,"user.motif.color")
LargeIconUrl.s = CkJsonObject::ckStringOf(jResp,"user.motif.largeIconUrl")
MediumIconUrl.s = CkJsonObject::ckStringOf(jResp,"user.motif.mediumIconUrl")
SmallIconUrl.s = CkJsonObject::ckStringOf(jResp,"user.motif.smallIconUrl")
SvgIconUrl.s = CkJsonObject::ckStringOf(jResp,"user.motif.svgIconUrl")
MySubscription.s = CkJsonObject::ckStringOf(jResp,"user.mySubscription")
Name.s = CkJsonObject::ckStringOf(jResp,"user.name")
Message.s = CkJsonObject::ckStringOf(jResp,"user.outOfOffice.message")
FullEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.fullEmailPhotoUrl")
LargePhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.largePhotoUrl")
MediumPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.mediumPhotoUrl")
PhotoVersionId.s = CkJsonObject::ckStringOf(jResp,"user.photo.photoVersionId")
SmallPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.smallPhotoUrl")
StandardEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.standardEmailPhotoUrl")
PhotoUrl.s = CkJsonObject::ckStringOf(jResp,"user.photo.url")
Reputation.s = CkJsonObject::ckStringOf(jResp,"user.reputation")
Title.s = CkJsonObject::ckStringOf(jResp,"user.title")
v_Type.s = CkJsonObject::ckStringOf(jResp,"user.type")
userUrl.s = CkJsonObject::ckStringOf(jResp,"user.url")
UserType.s = CkJsonObject::ckStringOf(jResp,"user.userType")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"body.messageSegments")
While i < count_i
CkJsonObject::setCkI(jResp, i)
altText = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].altText")
htmlTag = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].htmlTag")
markupType = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].markupType")
text = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].text")
v_type = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].type")
url = CkJsonObject::ckStringOf(jResp,"body.messageSegments[i].url")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"likes.items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
