Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "checksum": "71a50dbba44c78128b221b7df7bb51f1",
# "contentHubRepository": null,
# "contentModifiedDate": "2023-11-20T16:28:22.000Z",
# "contentSize": 95,
# "contentUrl": null,
# "createdDate": "2023-11-20T16:28:22.000Z",
# "description": null,
# "downloadUrl": "/services/data/v58.0/connect/files/069.../content?versionNumber=1",
# "externalDocumentUrl": null,
# "externalFilePermissionInformation": null,
# "fileAsset": null,
# "fileExtension": "png",
# "fileType": "Png",
# "flashRenditionStatus": "Na",
# "id": "069...",
# "isFileAsset": false,
# "isInMyFileSync": false,
# "isMajorVersion": true,
# "mimeType": "image/png",
# "moderationFlags": null,
# "modifiedDate": "2023-11-20T16:28:22.000Z",
# "motif": {
# "color": "939393",
# "largeIconUrl": "/img/content/content64.png",
# "mediumIconUrl": "/img/content/content32.png",
# "smallIconUrl": "/img/icon/files16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "1x1.png",
# "origin": "Chatter",
# "owner": {
# "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"
# },
# "pageCount": 0,
# "parentFolder": null,
# "pdfRenditionStatus": "Na",
# "publishStatus": "PrivateAccess",
# "renditionUrl": "/services/data/v58.0/connect/files/069.../rendition?type=THUMB120BY90",
# "renditionUrl240By180": "/services/data/v58.0/connect/files/069.../rendition?type=THUMB240BY180",
# "renditionUrl720By480": "/services/data/v58.0/connect/files/069.../rendition?type=THUMB720BY480",
# "repositoryFileId": null,
# "repositoryFileUrl": null,
# "sharingOption": "Allowed",
# "sharingPrivacy": "None",
# "sharingRole": "Owner",
# "systemModstamp": "2023-11-20T16:28:23.000Z",
# "textPreview": null,
# "thumb120By90RenditionStatus": "NotScheduled",
# "thumb240By180RenditionStatus": "NotScheduled",
# "thumb720By480RenditionStatus": "NotScheduled",
# "title": "1x1.png",
# "topics": {
# "currentPageUrl": null,
# "nextPageUrl": null,
# "topics": [
# ]
# },
# "type": "File",
# "url": "/services/data/v58.0/connect/files/069...?versionNumber=1",
# "versionNumber": "1"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
checksum = jResp.stringOf("checksum")
contentHubRepository = jResp.stringOf("contentHubRepository")
contentModifiedDate = jResp.stringOf("contentModifiedDate")
contentSize = jResp.IntOf("contentSize")
contentUrl = jResp.stringOf("contentUrl")
createdDate = jResp.stringOf("createdDate")
description = jResp.stringOf("description")
downloadUrl = jResp.stringOf("downloadUrl")
externalDocumentUrl = jResp.stringOf("externalDocumentUrl")
externalFilePermissionInformation = jResp.stringOf("externalFilePermissionInformation")
fileAsset = jResp.stringOf("fileAsset")
fileExtension = jResp.stringOf("fileExtension")
fileType = jResp.stringOf("fileType")
flashRenditionStatus = jResp.stringOf("flashRenditionStatus")
id = jResp.stringOf("id")
isFileAsset = jResp.BoolOf("isFileAsset")
isInMyFileSync = jResp.BoolOf("isInMyFileSync")
isMajorVersion = jResp.BoolOf("isMajorVersion")
mimeType = jResp.stringOf("mimeType")
moderationFlags = jResp.stringOf("moderationFlags")
modifiedDate = jResp.stringOf("modifiedDate")
Color = jResp.stringOf("motif.color")
LargeIconUrl = jResp.stringOf("motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("motif.svgIconUrl")
mySubscription = jResp.stringOf("mySubscription")
name = jResp.stringOf("name")
origin = jResp.stringOf("origin")
AdditionalLabel = jResp.stringOf("owner.additionalLabel")
CommunityNickname = jResp.stringOf("owner.communityNickname")
CompanyName = jResp.stringOf("owner.companyName")
DisplayName = jResp.stringOf("owner.displayName")
FirstName = jResp.stringOf("owner.firstName")
Id = jResp.stringOf("owner.id")
IsActive = jResp.BoolOf("owner.isActive")
IsInThisCommunity = jResp.BoolOf("owner.isInThisCommunity")
LastName = jResp.stringOf("owner.lastName")
MotifColor = jResp.stringOf("owner.motif.color")
MotifLargeIconUrl = jResp.stringOf("owner.motif.largeIconUrl")
MotifMediumIconUrl = jResp.stringOf("owner.motif.mediumIconUrl")
MotifSmallIconUrl = jResp.stringOf("owner.motif.smallIconUrl")
MotifSvgIconUrl = jResp.stringOf("owner.motif.svgIconUrl")
MySubscription = jResp.stringOf("owner.mySubscription")
Name = jResp.stringOf("owner.name")
Message = jResp.stringOf("owner.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("owner.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("owner.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("owner.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("owner.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("owner.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("owner.photo.standardEmailPhotoUrl")
v_Url = jResp.stringOf("owner.photo.url")
Reputation = jResp.stringOf("owner.reputation")
Title = jResp.stringOf("owner.title")
v_Type = jResp.stringOf("owner.type")
ownerUrl = jResp.stringOf("owner.url")
UserType = jResp.stringOf("owner.userType")
pageCount = jResp.IntOf("pageCount")
parentFolder = jResp.stringOf("parentFolder")
pdfRenditionStatus = jResp.stringOf("pdfRenditionStatus")
publishStatus = jResp.stringOf("publishStatus")
renditionUrl = jResp.stringOf("renditionUrl")
renditionUrl240By180 = jResp.stringOf("renditionUrl240By180")
renditionUrl720By480 = jResp.stringOf("renditionUrl720By480")
repositoryFileId = jResp.stringOf("repositoryFileId")
repositoryFileUrl = jResp.stringOf("repositoryFileUrl")
sharingOption = jResp.stringOf("sharingOption")
sharingPrivacy = jResp.stringOf("sharingPrivacy")
sharingRole = jResp.stringOf("sharingRole")
systemModstamp = jResp.stringOf("systemModstamp")
textPreview = jResp.stringOf("textPreview")
thumb120By90RenditionStatus = jResp.stringOf("thumb120By90RenditionStatus")
thumb240By180RenditionStatus = jResp.stringOf("thumb240By180RenditionStatus")
thumb720By480RenditionStatus = jResp.stringOf("thumb720By480RenditionStatus")
title = jResp.stringOf("title")
CurrentPageUrl = jResp.stringOf("topics.currentPageUrl")
NextPageUrl = jResp.stringOf("topics.nextPageUrl")
v_type = jResp.stringOf("type")
url = jResp.stringOf("url")
versionNumber = jResp.stringOf("versionNumber")
i = 0
count_i = jResp.SizeOfArray("topics.topics")
while i < count_i
jResp.put_I(i)
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID
Postman Collection Item JSON
{
"name": "File Information",
"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",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID"
],
"variable": [
{
"key": "FILE_ID",
"value": ""
}
]
},
"description": "Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.\nTo upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See Uploading Binary Files. To upload a new file to the Files home, use /connect/files/users/me.Get information about a specified file, including references to external files.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_information.htm"
},
"response": [
{
"name": "File Information",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID"
],
"variable": [
{
"key": "FILE_ID",
"value": "0692o00000woaKjAAI"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:33:38 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 \"checksum\": \"71a50dbba44c78128b221b7df7bb51f1\",\n \"contentHubRepository\": null,\n \"contentModifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"contentSize\": 95,\n \"contentUrl\": null,\n \"createdDate\": \"2023-11-20T16:28:22.000Z\",\n \"description\": null,\n \"downloadUrl\": \"/services/data/v58.0/connect/files/069.../content?versionNumber=1\",\n \"externalDocumentUrl\": null,\n \"externalFilePermissionInformation\": null,\n \"fileAsset\": null,\n \"fileExtension\": \"png\",\n \"fileType\": \"Png\",\n \"flashRenditionStatus\": \"Na\",\n \"id\": \"069...\",\n \"isFileAsset\": false,\n \"isInMyFileSync\": false,\n \"isMajorVersion\": true,\n \"mimeType\": \"image/png\",\n \"moderationFlags\": null,\n \"modifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"motif\": {\n \"color\": \"939393\",\n \"largeIconUrl\": \"/img/content/content64.png\",\n \"mediumIconUrl\": \"/img/content/content32.png\",\n \"smallIconUrl\": \"/img/icon/files16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"1x1.png\",\n \"origin\": \"Chatter\",\n \"owner\": {\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 \"pageCount\": 0,\n \"parentFolder\": null,\n \"pdfRenditionStatus\": \"Na\",\n \"publishStatus\": \"PrivateAccess\",\n \"renditionUrl\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB120BY90\",\n \"renditionUrl240By180\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB240BY180\",\n \"renditionUrl720By480\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB720BY480\",\n \"repositoryFileId\": null,\n \"repositoryFileUrl\": null,\n \"sharingOption\": \"Allowed\",\n \"sharingPrivacy\": \"None\",\n \"sharingRole\": \"Owner\",\n \"systemModstamp\": \"2023-11-20T16:28:23.000Z\",\n \"textPreview\": null,\n \"thumb120By90RenditionStatus\": \"NotScheduled\",\n \"thumb240By180RenditionStatus\": \"NotScheduled\",\n \"thumb720By480RenditionStatus\": \"NotScheduled\",\n \"title\": \"1x1.png\",\n \"topics\": {\n \"currentPageUrl\": null,\n \"nextPageUrl\": null,\n \"topics\": []\n },\n \"type\": \"File\",\n \"url\": \"/services/data/v58.0/connect/files/069...?versionNumber=1\",\n \"versionNumber\": \"1\"\n}"
}
]
}
