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