Chilkat Online Tools

C# / Salesforce Platform APIs / File Information

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("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

string checksum = jResp.StringOf("checksum");
string contentHubRepository = jResp.StringOf("contentHubRepository");
string contentModifiedDate = jResp.StringOf("contentModifiedDate");
int contentSize = jResp.IntOf("contentSize");
string contentUrl = jResp.StringOf("contentUrl");
string createdDate = jResp.StringOf("createdDate");
string description = jResp.StringOf("description");
string downloadUrl = jResp.StringOf("downloadUrl");
string externalDocumentUrl = jResp.StringOf("externalDocumentUrl");
string externalFilePermissionInformation = jResp.StringOf("externalFilePermissionInformation");
string fileAsset = jResp.StringOf("fileAsset");
string fileExtension = jResp.StringOf("fileExtension");
string fileType = jResp.StringOf("fileType");
string flashRenditionStatus = jResp.StringOf("flashRenditionStatus");
string id = jResp.StringOf("id");
bool isFileAsset = jResp.BoolOf("isFileAsset");
bool isInMyFileSync = jResp.BoolOf("isInMyFileSync");
bool isMajorVersion = jResp.BoolOf("isMajorVersion");
string mimeType = jResp.StringOf("mimeType");
string moderationFlags = jResp.StringOf("moderationFlags");
string modifiedDate = jResp.StringOf("modifiedDate");
string Color = jResp.StringOf("motif.color");
string LargeIconUrl = jResp.StringOf("motif.largeIconUrl");
string MediumIconUrl = jResp.StringOf("motif.mediumIconUrl");
string SmallIconUrl = jResp.StringOf("motif.smallIconUrl");
string SvgIconUrl = jResp.StringOf("motif.svgIconUrl");
string mySubscription = jResp.StringOf("mySubscription");
string name = jResp.StringOf("name");
string origin = jResp.StringOf("origin");
string AdditionalLabel = jResp.StringOf("owner.additionalLabel");
string CommunityNickname = jResp.StringOf("owner.communityNickname");
string CompanyName = jResp.StringOf("owner.companyName");
string DisplayName = jResp.StringOf("owner.displayName");
string FirstName = jResp.StringOf("owner.firstName");
string Id = jResp.StringOf("owner.id");
bool IsActive = jResp.BoolOf("owner.isActive");
bool IsInThisCommunity = jResp.BoolOf("owner.isInThisCommunity");
string LastName = jResp.StringOf("owner.lastName");
string MotifColor = jResp.StringOf("owner.motif.color");
string MotifLargeIconUrl = jResp.StringOf("owner.motif.largeIconUrl");
string MotifMediumIconUrl = jResp.StringOf("owner.motif.mediumIconUrl");
string MotifSmallIconUrl = jResp.StringOf("owner.motif.smallIconUrl");
string MotifSvgIconUrl = jResp.StringOf("owner.motif.svgIconUrl");
string MySubscription = jResp.StringOf("owner.mySubscription");
string Name = jResp.StringOf("owner.name");
string Message = jResp.StringOf("owner.outOfOffice.message");
string FullEmailPhotoUrl = jResp.StringOf("owner.photo.fullEmailPhotoUrl");
string LargePhotoUrl = jResp.StringOf("owner.photo.largePhotoUrl");
string MediumPhotoUrl = jResp.StringOf("owner.photo.mediumPhotoUrl");
string PhotoVersionId = jResp.StringOf("owner.photo.photoVersionId");
string SmallPhotoUrl = jResp.StringOf("owner.photo.smallPhotoUrl");
string StandardEmailPhotoUrl = jResp.StringOf("owner.photo.standardEmailPhotoUrl");
string v_Url = jResp.StringOf("owner.photo.url");
string Reputation = jResp.StringOf("owner.reputation");
string Title = jResp.StringOf("owner.title");
string v_Type = jResp.StringOf("owner.type");
string ownerUrl = jResp.StringOf("owner.url");
string UserType = jResp.StringOf("owner.userType");
int pageCount = jResp.IntOf("pageCount");
string parentFolder = jResp.StringOf("parentFolder");
string pdfRenditionStatus = jResp.StringOf("pdfRenditionStatus");
string publishStatus = jResp.StringOf("publishStatus");
string renditionUrl = jResp.StringOf("renditionUrl");
string renditionUrl240By180 = jResp.StringOf("renditionUrl240By180");
string renditionUrl720By480 = jResp.StringOf("renditionUrl720By480");
string repositoryFileId = jResp.StringOf("repositoryFileId");
string repositoryFileUrl = jResp.StringOf("repositoryFileUrl");
string sharingOption = jResp.StringOf("sharingOption");
string sharingPrivacy = jResp.StringOf("sharingPrivacy");
string sharingRole = jResp.StringOf("sharingRole");
string systemModstamp = jResp.StringOf("systemModstamp");
string textPreview = jResp.StringOf("textPreview");
string thumb120By90RenditionStatus = jResp.StringOf("thumb120By90RenditionStatus");
string thumb240By180RenditionStatus = jResp.StringOf("thumb240By180RenditionStatus");
string thumb720By480RenditionStatus = jResp.StringOf("thumb720By480RenditionStatus");
string title = jResp.StringOf("title");
string CurrentPageUrl = jResp.StringOf("topics.currentPageUrl");
string NextPageUrl = jResp.StringOf("topics.nextPageUrl");
string v_type = jResp.StringOf("type");
string url = jResp.StringOf("url");
string versionNumber = jResp.StringOf("versionNumber");
int i = 0;
int count_i = jResp.SizeOfArray("topics.topics");
while (i < count_i) {
    jResp.I = 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}"
    }
  ]
}