Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sChecksum = $oJResp.StringOf("checksum")
Local $sContentHubRepository = $oJResp.StringOf("contentHubRepository")
Local $sContentModifiedDate = $oJResp.StringOf("contentModifiedDate")
Local $iContentSize = $oJResp.IntOf("contentSize")
Local $sContentUrl = $oJResp.StringOf("contentUrl")
Local $sCreatedDate = $oJResp.StringOf("createdDate")
Local $sDescription = $oJResp.StringOf("description")
Local $sDownloadUrl = $oJResp.StringOf("downloadUrl")
Local $sExternalDocumentUrl = $oJResp.StringOf("externalDocumentUrl")
Local $sExternalFilePermissionInformation = $oJResp.StringOf("externalFilePermissionInformation")
Local $sFileAsset = $oJResp.StringOf("fileAsset")
Local $sFileExtension = $oJResp.StringOf("fileExtension")
Local $sFileType = $oJResp.StringOf("fileType")
Local $sFlashRenditionStatus = $oJResp.StringOf("flashRenditionStatus")
Local $sId = $oJResp.StringOf("id")
Local $bIsFileAsset = $oJResp.BoolOf("isFileAsset")
Local $bIsInMyFileSync = $oJResp.BoolOf("isInMyFileSync")
Local $bIsMajorVersion = $oJResp.BoolOf("isMajorVersion")
Local $sMimeType = $oJResp.StringOf("mimeType")
Local $sModerationFlags = $oJResp.StringOf("moderationFlags")
Local $sModifiedDate = $oJResp.StringOf("modifiedDate")
Local $sColor = $oJResp.StringOf("motif.color")
Local $sLargeIconUrl = $oJResp.StringOf("motif.largeIconUrl")
Local $sMediumIconUrl = $oJResp.StringOf("motif.mediumIconUrl")
Local $sSmallIconUrl = $oJResp.StringOf("motif.smallIconUrl")
Local $sSvgIconUrl = $oJResp.StringOf("motif.svgIconUrl")
Local $sMySubscription = $oJResp.StringOf("mySubscription")
Local $sName = $oJResp.StringOf("name")
Local $sOrigin = $oJResp.StringOf("origin")
Local $sAdditionalLabel = $oJResp.StringOf("owner.additionalLabel")
Local $sCommunityNickname = $oJResp.StringOf("owner.communityNickname")
Local $sCompanyName = $oJResp.StringOf("owner.companyName")
Local $sDisplayName = $oJResp.StringOf("owner.displayName")
Local $sFirstName = $oJResp.StringOf("owner.firstName")
Local $sId = $oJResp.StringOf("owner.id")
Local $bIsActive = $oJResp.BoolOf("owner.isActive")
Local $bIsInThisCommunity = $oJResp.BoolOf("owner.isInThisCommunity")
Local $sLastName = $oJResp.StringOf("owner.lastName")
Local $sMotifColor = $oJResp.StringOf("owner.motif.color")
Local $sMotifLargeIconUrl = $oJResp.StringOf("owner.motif.largeIconUrl")
Local $sMotifMediumIconUrl = $oJResp.StringOf("owner.motif.mediumIconUrl")
Local $sMotifSmallIconUrl = $oJResp.StringOf("owner.motif.smallIconUrl")
Local $sMotifSvgIconUrl = $oJResp.StringOf("owner.motif.svgIconUrl")
Local $sMySubscription = $oJResp.StringOf("owner.mySubscription")
Local $sName = $oJResp.StringOf("owner.name")
Local $sMessage = $oJResp.StringOf("owner.outOfOffice.message")
Local $sFullEmailPhotoUrl = $oJResp.StringOf("owner.photo.fullEmailPhotoUrl")
Local $sLargePhotoUrl = $oJResp.StringOf("owner.photo.largePhotoUrl")
Local $sMediumPhotoUrl = $oJResp.StringOf("owner.photo.mediumPhotoUrl")
Local $sPhotoVersionId = $oJResp.StringOf("owner.photo.photoVersionId")
Local $sSmallPhotoUrl = $oJResp.StringOf("owner.photo.smallPhotoUrl")
Local $sStandardEmailPhotoUrl = $oJResp.StringOf("owner.photo.standardEmailPhotoUrl")
Local $sV_Url = $oJResp.StringOf("owner.photo.url")
Local $sReputation = $oJResp.StringOf("owner.reputation")
Local $sTitle = $oJResp.StringOf("owner.title")
Local $sV_Type = $oJResp.StringOf("owner.type")
Local $sOwnerUrl = $oJResp.StringOf("owner.url")
Local $sUserType = $oJResp.StringOf("owner.userType")
Local $iPageCount = $oJResp.IntOf("pageCount")
Local $sParentFolder = $oJResp.StringOf("parentFolder")
Local $sPdfRenditionStatus = $oJResp.StringOf("pdfRenditionStatus")
Local $sPublishStatus = $oJResp.StringOf("publishStatus")
Local $sRenditionUrl = $oJResp.StringOf("renditionUrl")
Local $sRenditionUrl240By180 = $oJResp.StringOf("renditionUrl240By180")
Local $sRenditionUrl720By480 = $oJResp.StringOf("renditionUrl720By480")
Local $sRepositoryFileId = $oJResp.StringOf("repositoryFileId")
Local $sRepositoryFileUrl = $oJResp.StringOf("repositoryFileUrl")
Local $sharingOption = $oJResp.StringOf("sharingOption")
Local $sharingPrivacy = $oJResp.StringOf("sharingPrivacy")
Local $sharingRole = $oJResp.StringOf("sharingRole")
Local $systemModstamp = $oJResp.StringOf("systemModstamp")
Local $sTextPreview = $oJResp.StringOf("textPreview")
Local $sThumb120By90RenditionStatus = $oJResp.StringOf("thumb120By90RenditionStatus")
Local $sThumb240By180RenditionStatus = $oJResp.StringOf("thumb240By180RenditionStatus")
Local $sThumb720By480RenditionStatus = $oJResp.StringOf("thumb720By480RenditionStatus")
Local $sTitle = $oJResp.StringOf("title")
Local $sCurrentPageUrl = $oJResp.StringOf("topics.currentPageUrl")
Local $sNextPageUrl = $oJResp.StringOf("topics.nextPageUrl")
Local $sV_type = $oJResp.StringOf("type")
Local $sUrl = $oJResp.StringOf("url")
Local $sVersionNumber = $oJResp.StringOf("versionNumber")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("topics.topics")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
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}"
}
]
}
