Chilkat Online Tools

Java / Salesforce Platform APIs / Users Files, General

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    CkHttpRequest req = new CkHttpRequest();
    req.put_HttpVerb("POST");
    req.put_Path("/services/data/v{{version}}/connect/files/users/me");
    req.put_ContentType("multipart/form-data");
    success = req.AddFileForUpload2("fileData"," path to file","application/octet-stream");

    req.AddHeader("Authorization","Bearer <access_token>");
    req.AddHeader("Expect","100-continue");

    CkHttpResponse resp = http.SynchronousRequest("domain.com",443,true,req);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("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");
    boolean isFileAsset = jResp.BoolOf("isFileAsset");
    boolean isInMyFileSync = jResp.BoolOf("isInMyFileSync");
    boolean 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");
    boolean IsActive = jResp.BoolOf("owner.isActive");
    boolean 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.put_I(i);
        i = i+1;
        }
  }
}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	--form 'fileData=@"/path/to/file"'
https://domain.com/services/data/v{{version}}/connect/files/users/me

Postman Collection Item JSON

{
  "name": "Users Files, General",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "fileData",
          "type": "file",
          "src": [
          ]
        }
      ]
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/users/me",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "files",
        "users",
        "me"
      ]
    },
    "description": "Upload a file, including references to external files, to the Files home or get information about files a user owns. These files don’t include files shared with a user, files a user follows, or general organization files.\nWhen you upload a file to the Files home, it is private and available only to the file owner.\n\nTo upload a file, send it in a multipart/form-data request. You can include the description and title of the file in the multipart/form-data request as a JSON or XML request body. You can also send the information as request parameters. For information about how to create the multipart/form-data message, see Uploading Binary Files.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_files_general.htm"
  },
  "response": [
    {
      "name": "Successful Users Files, General",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "fileData",
              "type": "file",
              "src": "/Users/scolladon/Downloads/1x1.png"
            }
          ]
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/users/me",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "files",
            "users",
            "me"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:28:22 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}"
    }
  ]
}