Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID",sbResponseBody)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print http.LastHeader
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim checksum As String
checksum = jResp.StringOf("checksum")
Dim contentHubRepository As String
contentHubRepository = jResp.StringOf("contentHubRepository")
Dim contentModifiedDate As String
contentModifiedDate = jResp.StringOf("contentModifiedDate")
Dim contentSize As Long
contentSize = jResp.IntOf("contentSize")
Dim contentUrl As String
contentUrl = jResp.StringOf("contentUrl")
Dim createdDate As String
createdDate = jResp.StringOf("createdDate")
Dim description As String
description = jResp.StringOf("description")
Dim downloadUrl As String
downloadUrl = jResp.StringOf("downloadUrl")
Dim externalDocumentUrl As String
externalDocumentUrl = jResp.StringOf("externalDocumentUrl")
Dim externalFilePermissionInformation As String
externalFilePermissionInformation = jResp.StringOf("externalFilePermissionInformation")
Dim fileAsset As String
fileAsset = jResp.StringOf("fileAsset")
Dim fileExtension As String
fileExtension = jResp.StringOf("fileExtension")
Dim fileType As String
fileType = jResp.StringOf("fileType")
Dim flashRenditionStatus As String
flashRenditionStatus = jResp.StringOf("flashRenditionStatus")
Dim id As String
id = jResp.StringOf("id")
Dim isFileAsset As Long
isFileAsset = jResp.BoolOf("isFileAsset")
Dim isInMyFileSync As Long
isInMyFileSync = jResp.BoolOf("isInMyFileSync")
Dim isMajorVersion As Long
isMajorVersion = jResp.BoolOf("isMajorVersion")
Dim mimeType As String
mimeType = jResp.StringOf("mimeType")
Dim moderationFlags As String
moderationFlags = jResp.StringOf("moderationFlags")
Dim modifiedDate As String
modifiedDate = jResp.StringOf("modifiedDate")
Dim Color As String
Color = jResp.StringOf("motif.color")
Dim LargeIconUrl As String
LargeIconUrl = jResp.StringOf("motif.largeIconUrl")
Dim MediumIconUrl As String
MediumIconUrl = jResp.StringOf("motif.mediumIconUrl")
Dim SmallIconUrl As String
SmallIconUrl = jResp.StringOf("motif.smallIconUrl")
Dim SvgIconUrl As String
SvgIconUrl = jResp.StringOf("motif.svgIconUrl")
Dim mySubscription As String
mySubscription = jResp.StringOf("mySubscription")
Dim name As String
name = jResp.StringOf("name")
Dim origin As String
origin = jResp.StringOf("origin")
Dim AdditionalLabel As String
AdditionalLabel = jResp.StringOf("owner.additionalLabel")
Dim CommunityNickname As String
CommunityNickname = jResp.StringOf("owner.communityNickname")
Dim CompanyName As String
CompanyName = jResp.StringOf("owner.companyName")
Dim DisplayName As String
DisplayName = jResp.StringOf("owner.displayName")
Dim FirstName As String
FirstName = jResp.StringOf("owner.firstName")
Dim Id As String
Id = jResp.StringOf("owner.id")
Dim IsActive As Long
IsActive = jResp.BoolOf("owner.isActive")
Dim IsInThisCommunity As Long
IsInThisCommunity = jResp.BoolOf("owner.isInThisCommunity")
Dim LastName As String
LastName = jResp.StringOf("owner.lastName")
Dim MotifColor As String
MotifColor = jResp.StringOf("owner.motif.color")
Dim MotifLargeIconUrl As String
MotifLargeIconUrl = jResp.StringOf("owner.motif.largeIconUrl")
Dim MotifMediumIconUrl As String
MotifMediumIconUrl = jResp.StringOf("owner.motif.mediumIconUrl")
Dim MotifSmallIconUrl As String
MotifSmallIconUrl = jResp.StringOf("owner.motif.smallIconUrl")
Dim MotifSvgIconUrl As String
MotifSvgIconUrl = jResp.StringOf("owner.motif.svgIconUrl")
Dim MySubscription As String
MySubscription = jResp.StringOf("owner.mySubscription")
Dim Name As String
Name = jResp.StringOf("owner.name")
Dim Message As String
Message = jResp.StringOf("owner.outOfOffice.message")
Dim FullEmailPhotoUrl As String
FullEmailPhotoUrl = jResp.StringOf("owner.photo.fullEmailPhotoUrl")
Dim LargePhotoUrl As String
LargePhotoUrl = jResp.StringOf("owner.photo.largePhotoUrl")
Dim MediumPhotoUrl As String
MediumPhotoUrl = jResp.StringOf("owner.photo.mediumPhotoUrl")
Dim PhotoVersionId As String
PhotoVersionId = jResp.StringOf("owner.photo.photoVersionId")
Dim SmallPhotoUrl As String
SmallPhotoUrl = jResp.StringOf("owner.photo.smallPhotoUrl")
Dim StandardEmailPhotoUrl As String
StandardEmailPhotoUrl = jResp.StringOf("owner.photo.standardEmailPhotoUrl")
Dim v_Url As String
v_Url = jResp.StringOf("owner.photo.url")
Dim Reputation As String
Reputation = jResp.StringOf("owner.reputation")
Dim Title As String
Title = jResp.StringOf("owner.title")
Dim v_Type As String
v_Type = jResp.StringOf("owner.type")
Dim ownerUrl As String
ownerUrl = jResp.StringOf("owner.url")
Dim UserType As String
UserType = jResp.StringOf("owner.userType")
Dim pageCount As Long
pageCount = jResp.IntOf("pageCount")
Dim parentFolder As String
parentFolder = jResp.StringOf("parentFolder")
Dim pdfRenditionStatus As String
pdfRenditionStatus = jResp.StringOf("pdfRenditionStatus")
Dim publishStatus As String
publishStatus = jResp.StringOf("publishStatus")
Dim renditionUrl As String
renditionUrl = jResp.StringOf("renditionUrl")
Dim renditionUrl240By180 As String
renditionUrl240By180 = jResp.StringOf("renditionUrl240By180")
Dim renditionUrl720By480 As String
renditionUrl720By480 = jResp.StringOf("renditionUrl720By480")
Dim repositoryFileId As String
repositoryFileId = jResp.StringOf("repositoryFileId")
Dim repositoryFileUrl As String
repositoryFileUrl = jResp.StringOf("repositoryFileUrl")
Dim sharingOption As String
sharingOption = jResp.StringOf("sharingOption")
Dim sharingPrivacy As String
sharingPrivacy = jResp.StringOf("sharingPrivacy")
Dim sharingRole As String
sharingRole = jResp.StringOf("sharingRole")
Dim systemModstamp As String
systemModstamp = jResp.StringOf("systemModstamp")
Dim textPreview As String
textPreview = jResp.StringOf("textPreview")
Dim thumb120By90RenditionStatus As String
thumb120By90RenditionStatus = jResp.StringOf("thumb120By90RenditionStatus")
Dim thumb240By180RenditionStatus As String
thumb240By180RenditionStatus = jResp.StringOf("thumb240By180RenditionStatus")
Dim thumb720By480RenditionStatus As String
thumb720By480RenditionStatus = jResp.StringOf("thumb720By480RenditionStatus")
Dim title As String
title = jResp.StringOf("title")
Dim CurrentPageUrl As String
CurrentPageUrl = jResp.StringOf("topics.currentPageUrl")
Dim NextPageUrl As String
NextPageUrl = jResp.StringOf("topics.nextPageUrl")
Dim v_type As String
v_type = jResp.StringOf("type")
Dim url As String
url = jResp.StringOf("url")
Dim versionNumber As String
versionNumber = jResp.StringOf("versionNumber")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("topics.topics")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
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}"
}
]
}
