Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAdditionalLabel
LOCAL lcCommunityNickname
LOCAL lcCompanyName
LOCAL lcDisplayName
LOCAL lcFirstName
LOCAL lcId
LOCAL lnIsActive
LOCAL lnIsInThisCommunity
LOCAL lcLastName
LOCAL lcColor
LOCAL lcLargeIconUrl
LOCAL lcMediumIconUrl
LOCAL lcSmallIconUrl
LOCAL lcSvgIconUrl
LOCAL lcMySubscription
LOCAL lcName
LOCAL lcMessage
LOCAL lcFullEmailPhotoUrl
LOCAL lcLargePhotoUrl
LOCAL lcMediumPhotoUrl
LOCAL lcPhotoVersionId
LOCAL lcSmallPhotoUrl
LOCAL lcStandardEmailPhotoUrl
LOCAL lcV_Url
LOCAL lcReputation
LOCAL lcTitle
LOCAL lcV_Type
LOCAL lcEntityUrl
LOCAL lcUserType
LOCAL lcSharingType
LOCAL lcCurrentPageUrl
LOCAL lcLinkShare
LOCAL lcNextPageUrl
LOCAL lcPreviousPageUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "currentPageUrl": "/services/data/v58.0/connect/files/069.../file-shares",
* "linkShare": null,
* "nextPageUrl": null,
* "previousPageUrl": null,
* "shares": [
* {
* "entity": {
* "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/7292o000000oAgZ/F",
* "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
* "photoVersionId": "729...",
* "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/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"
* },
* "sharingType": "I"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCurrentPageUrl = loJResp.StringOf("currentPageUrl")
lcLinkShare = loJResp.StringOf("linkShare")
lcNextPageUrl = loJResp.StringOf("nextPageUrl")
lcPreviousPageUrl = loJResp.StringOf("previousPageUrl")
i = 0
lnCount_i = loJResp.SizeOfArray("shares")
DO WHILE i < lnCount_i
loJResp.I = i
lcAdditionalLabel = loJResp.StringOf("shares[i].entity.additionalLabel")
lcCommunityNickname = loJResp.StringOf("shares[i].entity.communityNickname")
lcCompanyName = loJResp.StringOf("shares[i].entity.companyName")
lcDisplayName = loJResp.StringOf("shares[i].entity.displayName")
lcFirstName = loJResp.StringOf("shares[i].entity.firstName")
lcId = loJResp.StringOf("shares[i].entity.id")
lnIsActive = loJResp.BoolOf("shares[i].entity.isActive")
lnIsInThisCommunity = loJResp.BoolOf("shares[i].entity.isInThisCommunity")
lcLastName = loJResp.StringOf("shares[i].entity.lastName")
lcColor = loJResp.StringOf("shares[i].entity.motif.color")
lcLargeIconUrl = loJResp.StringOf("shares[i].entity.motif.largeIconUrl")
lcMediumIconUrl = loJResp.StringOf("shares[i].entity.motif.mediumIconUrl")
lcSmallIconUrl = loJResp.StringOf("shares[i].entity.motif.smallIconUrl")
lcSvgIconUrl = loJResp.StringOf("shares[i].entity.motif.svgIconUrl")
lcMySubscription = loJResp.StringOf("shares[i].entity.mySubscription")
lcName = loJResp.StringOf("shares[i].entity.name")
lcMessage = loJResp.StringOf("shares[i].entity.outOfOffice.message")
lcFullEmailPhotoUrl = loJResp.StringOf("shares[i].entity.photo.fullEmailPhotoUrl")
lcLargePhotoUrl = loJResp.StringOf("shares[i].entity.photo.largePhotoUrl")
lcMediumPhotoUrl = loJResp.StringOf("shares[i].entity.photo.mediumPhotoUrl")
lcPhotoVersionId = loJResp.StringOf("shares[i].entity.photo.photoVersionId")
lcSmallPhotoUrl = loJResp.StringOf("shares[i].entity.photo.smallPhotoUrl")
lcStandardEmailPhotoUrl = loJResp.StringOf("shares[i].entity.photo.standardEmailPhotoUrl")
lcV_Url = loJResp.StringOf("shares[i].entity.photo.url")
lcReputation = loJResp.StringOf("shares[i].entity.reputation")
lcTitle = loJResp.StringOf("shares[i].entity.title")
lcV_Type = loJResp.StringOf("shares[i].entity.type")
lcEntityUrl = loJResp.StringOf("shares[i].entity.url")
lcUserType = loJResp.StringOf("shares[i].entity.userType")
lcSharingType = loJResp.StringOf("shares[i].sharingType")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares
Postman Collection Item JSON
{
"name": "File Shares",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": ""
}
]
},
"description": "Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm"
},
"response": [
{
"name": "Successful File Shares",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": "0692o00000woaRkAAI"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:37:07 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 \"currentPageUrl\": \"/services/data/v58.0/connect/files/069.../file-shares\",\n \"linkShare\": null,\n \"nextPageUrl\": null,\n \"previousPageUrl\": null,\n \"shares\": [\n {\n \"entity\": {\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/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/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 \"sharingType\": \"I\"\n }\n ]\n}"
}
]
}
