Chilkat Online Tools

VB.NET / Salesforce Platform APIs / Users Files, General

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 Chilkat.Http
Dim success As Boolean

Dim req As New Chilkat.HttpRequest
req.HttpVerb = "POST"
req.Path = "/services/data/v{{version}}/connect/files/users/me"
req.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")

Dim resp As Chilkat.HttpResponse = http.SynchronousRequest("domain.com",443,True,req)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

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

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}"
    }
  ]
}