Chilkat Online Tools

TCL / Salesforce Platform APIs / Users Files, General

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/services/data/v{{version}}/connect/files/users/me"
CkHttpRequest_put_ContentType $req "multipart/form-data"
set success [CkHttpRequest_AddFileForUpload2 $req "fileData" " path to file" "application/octet-stream"]

CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
CkHttpRequest_AddHeader $req "Expect" "100-continue"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpSReq $http "domain.com" 443 1 $req $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

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

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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