Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
return
}
// 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
var AdditionalLabel: String?
var CommunityNickname: String?
var CompanyName: String?
var DisplayName: String?
var FirstName: String?
var Id: String?
var IsActive: Bool
var IsInThisCommunity: Bool
var LastName: String?
var Color: String?
var LargeIconUrl: String?
var MediumIconUrl: String?
var SmallIconUrl: String?
var SvgIconUrl: String?
var MySubscription: String?
var Name: String?
var Message: String?
var FullEmailPhotoUrl: String?
var LargePhotoUrl: String?
var MediumPhotoUrl: String?
var PhotoVersionId: String?
var SmallPhotoUrl: String?
var StandardEmailPhotoUrl: String?
var v_Url: String?
var Reputation: String?
var Title: String?
var v_Type: String?
var entityUrl: String?
var UserType: String?
var sharingType: String?
var currentPageUrl: String? = jResp.string(of: "currentPageUrl")
var linkShare: String? = jResp.string(of: "linkShare")
var nextPageUrl: String? = jResp.string(of: "nextPageUrl")
var previousPageUrl: String? = jResp.string(of: "previousPageUrl")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "shares").intValue
while i < count_i {
jResp.i = i
AdditionalLabel = jResp.string(of: "shares[i].entity.additionalLabel")
CommunityNickname = jResp.string(of: "shares[i].entity.communityNickname")
CompanyName = jResp.string(of: "shares[i].entity.companyName")
DisplayName = jResp.string(of: "shares[i].entity.displayName")
FirstName = jResp.string(of: "shares[i].entity.firstName")
Id = jResp.string(of: "shares[i].entity.id")
IsActive = jResp.bool(of: "shares[i].entity.isActive")
IsInThisCommunity = jResp.bool(of: "shares[i].entity.isInThisCommunity")
LastName = jResp.string(of: "shares[i].entity.lastName")
Color = jResp.string(of: "shares[i].entity.motif.color")
LargeIconUrl = jResp.string(of: "shares[i].entity.motif.largeIconUrl")
MediumIconUrl = jResp.string(of: "shares[i].entity.motif.mediumIconUrl")
SmallIconUrl = jResp.string(of: "shares[i].entity.motif.smallIconUrl")
SvgIconUrl = jResp.string(of: "shares[i].entity.motif.svgIconUrl")
MySubscription = jResp.string(of: "shares[i].entity.mySubscription")
Name = jResp.string(of: "shares[i].entity.name")
Message = jResp.string(of: "shares[i].entity.outOfOffice.message")
FullEmailPhotoUrl = jResp.string(of: "shares[i].entity.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.string(of: "shares[i].entity.photo.largePhotoUrl")
MediumPhotoUrl = jResp.string(of: "shares[i].entity.photo.mediumPhotoUrl")
PhotoVersionId = jResp.string(of: "shares[i].entity.photo.photoVersionId")
SmallPhotoUrl = jResp.string(of: "shares[i].entity.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.string(of: "shares[i].entity.photo.standardEmailPhotoUrl")
v_Url = jResp.string(of: "shares[i].entity.photo.url")
Reputation = jResp.string(of: "shares[i].entity.reputation")
Title = jResp.string(of: "shares[i].entity.title")
v_Type = jResp.string(of: "shares[i].entity.type")
entityUrl = jResp.string(of: "shares[i].entity.url")
UserType = jResp.string(of: "shares[i].entity.userType")
sharingType = jResp.string(of: "shares[i].sharingType")
i = i + 1
}
}
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}"
}
]
}
