Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set currentPageUrl [CkJsonObject_stringOf $jResp "currentPageUrl"]
set linkShare [CkJsonObject_stringOf $jResp "linkShare"]
set nextPageUrl [CkJsonObject_stringOf $jResp "nextPageUrl"]
set previousPageUrl [CkJsonObject_stringOf $jResp "previousPageUrl"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "shares"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set AdditionalLabel [CkJsonObject_stringOf $jResp "shares[i].entity.additionalLabel"]
set CommunityNickname [CkJsonObject_stringOf $jResp "shares[i].entity.communityNickname"]
set CompanyName [CkJsonObject_stringOf $jResp "shares[i].entity.companyName"]
set DisplayName [CkJsonObject_stringOf $jResp "shares[i].entity.displayName"]
set FirstName [CkJsonObject_stringOf $jResp "shares[i].entity.firstName"]
set Id [CkJsonObject_stringOf $jResp "shares[i].entity.id"]
set IsActive [CkJsonObject_BoolOf $jResp "shares[i].entity.isActive"]
set IsInThisCommunity [CkJsonObject_BoolOf $jResp "shares[i].entity.isInThisCommunity"]
set LastName [CkJsonObject_stringOf $jResp "shares[i].entity.lastName"]
set Color [CkJsonObject_stringOf $jResp "shares[i].entity.motif.color"]
set LargeIconUrl [CkJsonObject_stringOf $jResp "shares[i].entity.motif.largeIconUrl"]
set MediumIconUrl [CkJsonObject_stringOf $jResp "shares[i].entity.motif.mediumIconUrl"]
set SmallIconUrl [CkJsonObject_stringOf $jResp "shares[i].entity.motif.smallIconUrl"]
set SvgIconUrl [CkJsonObject_stringOf $jResp "shares[i].entity.motif.svgIconUrl"]
set MySubscription [CkJsonObject_stringOf $jResp "shares[i].entity.mySubscription"]
set Name [CkJsonObject_stringOf $jResp "shares[i].entity.name"]
set Message [CkJsonObject_stringOf $jResp "shares[i].entity.outOfOffice.message"]
set FullEmailPhotoUrl [CkJsonObject_stringOf $jResp "shares[i].entity.photo.fullEmailPhotoUrl"]
set LargePhotoUrl [CkJsonObject_stringOf $jResp "shares[i].entity.photo.largePhotoUrl"]
set MediumPhotoUrl [CkJsonObject_stringOf $jResp "shares[i].entity.photo.mediumPhotoUrl"]
set PhotoVersionId [CkJsonObject_stringOf $jResp "shares[i].entity.photo.photoVersionId"]
set SmallPhotoUrl [CkJsonObject_stringOf $jResp "shares[i].entity.photo.smallPhotoUrl"]
set StandardEmailPhotoUrl [CkJsonObject_stringOf $jResp "shares[i].entity.photo.standardEmailPhotoUrl"]
set v_Url [CkJsonObject_stringOf $jResp "shares[i].entity.photo.url"]
set Reputation [CkJsonObject_stringOf $jResp "shares[i].entity.reputation"]
set Title [CkJsonObject_stringOf $jResp "shares[i].entity.title"]
set v_Type [CkJsonObject_stringOf $jResp "shares[i].entity.type"]
set entityUrl [CkJsonObject_stringOf $jResp "shares[i].entity.url"]
set UserType [CkJsonObject_stringOf $jResp "shares[i].entity.userType"]
set sharingType [CkJsonObject_stringOf $jResp "shares[i].sharingType"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
