Chilkat Online Tools

Python / Salesforce Platform APIs / Comment

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# 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 = chilkat2.JsonObject()
json.UpdateString("body.messageSegments[0].type","Text")
json.UpdateString("body.messageSegments[0].text","Editing a comment")

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("GET","https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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

IsRichText = jResp.BoolOf("body.isRichText")
Text = jResp.StringOf("body.text")
IsEditRestricted = jResp.BoolOf("capabilities.edit.isEditRestricted")
IsEditableByMeUrl = jResp.StringOf("capabilities.edit.isEditableByMeUrl")
LastEditedBy = jResp.StringOf("capabilities.edit.lastEditedBy")
LastEditedDate = jResp.StringOf("capabilities.edit.lastEditedDate")
LatestRevision = jResp.IntOf("capabilities.edit.latestRevision")
RelativeLastEditedDate = jResp.StringOf("capabilities.edit.relativeLastEditedDate")
FeedEntityStatus = jResp.StringOf("capabilities.status.feedEntityStatus")
IsApprovableByMe = jResp.BoolOf("capabilities.status.isApprovableByMe")
DownVoteCount = jResp.IntOf("capabilities.upDownVote.downVoteCount")
MyVote = jResp.StringOf("capabilities.upDownVote.myVote")
UpVoteCount = jResp.IntOf("capabilities.upDownVote.upVoteCount")
IsVerifiableByMe = jResp.BoolOf("capabilities.verified.isVerifiableByMe")
IsVerified = jResp.BoolOf("capabilities.verified.isVerified")
IsVerifiedByAnonymized = jResp.StringOf("capabilities.verified.isVerifiedByAnonymized")
LastVerifiedByUser = jResp.StringOf("capabilities.verified.lastVerifiedByUser")
LastVerifiedDate = jResp.StringOf("capabilities.verified.lastVerifiedDate")
clientInfo = jResp.StringOf("clientInfo")
createdDate = jResp.StringOf("createdDate")
Id = jResp.StringOf("feedElement.id")
v_Url = jResp.StringOf("feedElement.url")
id = jResp.StringOf("id")
isDeleteRestricted = jResp.BoolOf("isDeleteRestricted")
CurrentPageToken = jResp.StringOf("likes.currentPageToken")
CurrentPageUrl = jResp.StringOf("likes.currentPageUrl")
NextPageToken = jResp.StringOf("likes.nextPageToken")
NextPageUrl = jResp.StringOf("likes.nextPageUrl")
PreviousPageToken = jResp.StringOf("likes.previousPageToken")
PreviousPageUrl = jResp.StringOf("likes.previousPageUrl")
Total = jResp.IntOf("likes.total")
likesMessage = jResp.StringOf("likesMessage")
moderationFlags = jResp.StringOf("moderationFlags")
myLike = jResp.StringOf("myLike")
parentId = jResp.StringOf("parent.id")
parentUrl = jResp.StringOf("parent.url")
relativeCreatedDate = jResp.StringOf("relativeCreatedDate")
threadLevel = jResp.IntOf("threadLevel")
threadParentId = jResp.StringOf("threadParentId")
v_type = jResp.StringOf("type")
url = jResp.StringOf("url")
AdditionalLabel = jResp.StringOf("user.additionalLabel")
CommunityNickname = jResp.StringOf("user.communityNickname")
CompanyName = jResp.StringOf("user.companyName")
DisplayName = jResp.StringOf("user.displayName")
FirstName = jResp.StringOf("user.firstName")
userId = jResp.StringOf("user.id")
IsActive = jResp.BoolOf("user.isActive")
IsInThisCommunity = jResp.BoolOf("user.isInThisCommunity")
LastName = jResp.StringOf("user.lastName")
Color = jResp.StringOf("user.motif.color")
LargeIconUrl = jResp.StringOf("user.motif.largeIconUrl")
MediumIconUrl = jResp.StringOf("user.motif.mediumIconUrl")
SmallIconUrl = jResp.StringOf("user.motif.smallIconUrl")
SvgIconUrl = jResp.StringOf("user.motif.svgIconUrl")
MySubscription = jResp.StringOf("user.mySubscription")
Name = jResp.StringOf("user.name")
Message = jResp.StringOf("user.outOfOffice.message")
FullEmailPhotoUrl = jResp.StringOf("user.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.StringOf("user.photo.largePhotoUrl")
MediumPhotoUrl = jResp.StringOf("user.photo.mediumPhotoUrl")
PhotoVersionId = jResp.StringOf("user.photo.photoVersionId")
SmallPhotoUrl = jResp.StringOf("user.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.StringOf("user.photo.standardEmailPhotoUrl")
PhotoUrl = jResp.StringOf("user.photo.url")
Reputation = jResp.StringOf("user.reputation")
Title = jResp.StringOf("user.title")
v_Type = jResp.StringOf("user.type")
userUrl = jResp.StringOf("user.url")
UserType = jResp.StringOf("user.userType")
i = 0
count_i = jResp.SizeOfArray("body.messageSegments")
while i < count_i :
    jResp.I = i
    altText = jResp.StringOf("body.messageSegments[i].altText")
    htmlTag = jResp.StringOf("body.messageSegments[i].htmlTag")
    markupType = jResp.StringOf("body.messageSegments[i].markupType")
    text = jResp.StringOf("body.messageSegments[i].text")
    v_type = jResp.StringOf("body.messageSegments[i].type")
    url = jResp.StringOf("body.messageSegments[i].url")
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("likes.items")
while i < count_i :
    jResp.I = i
    i = i + 1

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}"
    }
  ]
}