Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::setCkHttpVerb(req, "POST")
CkHttpRequest::setCkPath(req, "/services/data/v{{version}}/connect/files/users/me")
CkHttpRequest::setCkContentType(req, "multipart/form-data")
success = CkHttpRequest::ckAddFileForUpload2(req,"fileData"," path to file","application/octet-stream")
CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")
CkHttpRequest::ckAddHeader(req,"Expect","100-continue")
resp.i = CkHttp::ckSynchronousRequest(http,"domain.com",443,1,req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
checksum.s = CkJsonObject::ckStringOf(jResp,"checksum")
contentHubRepository.s = CkJsonObject::ckStringOf(jResp,"contentHubRepository")
contentModifiedDate.s = CkJsonObject::ckStringOf(jResp,"contentModifiedDate")
contentSize.i = CkJsonObject::ckIntOf(jResp,"contentSize")
contentUrl.s = CkJsonObject::ckStringOf(jResp,"contentUrl")
createdDate.s = CkJsonObject::ckStringOf(jResp,"createdDate")
description.s = CkJsonObject::ckStringOf(jResp,"description")
downloadUrl.s = CkJsonObject::ckStringOf(jResp,"downloadUrl")
externalDocumentUrl.s = CkJsonObject::ckStringOf(jResp,"externalDocumentUrl")
externalFilePermissionInformation.s = CkJsonObject::ckStringOf(jResp,"externalFilePermissionInformation")
fileAsset.s = CkJsonObject::ckStringOf(jResp,"fileAsset")
fileExtension.s = CkJsonObject::ckStringOf(jResp,"fileExtension")
fileType.s = CkJsonObject::ckStringOf(jResp,"fileType")
flashRenditionStatus.s = CkJsonObject::ckStringOf(jResp,"flashRenditionStatus")
id.s = CkJsonObject::ckStringOf(jResp,"id")
isFileAsset.i = CkJsonObject::ckBoolOf(jResp,"isFileAsset")
isInMyFileSync.i = CkJsonObject::ckBoolOf(jResp,"isInMyFileSync")
isMajorVersion.i = CkJsonObject::ckBoolOf(jResp,"isMajorVersion")
mimeType.s = CkJsonObject::ckStringOf(jResp,"mimeType")
moderationFlags.s = CkJsonObject::ckStringOf(jResp,"moderationFlags")
modifiedDate.s = CkJsonObject::ckStringOf(jResp,"modifiedDate")
Color.s = CkJsonObject::ckStringOf(jResp,"motif.color")
LargeIconUrl.s = CkJsonObject::ckStringOf(jResp,"motif.largeIconUrl")
MediumIconUrl.s = CkJsonObject::ckStringOf(jResp,"motif.mediumIconUrl")
SmallIconUrl.s = CkJsonObject::ckStringOf(jResp,"motif.smallIconUrl")
SvgIconUrl.s = CkJsonObject::ckStringOf(jResp,"motif.svgIconUrl")
mySubscription.s = CkJsonObject::ckStringOf(jResp,"mySubscription")
name.s = CkJsonObject::ckStringOf(jResp,"name")
origin.s = CkJsonObject::ckStringOf(jResp,"origin")
AdditionalLabel.s = CkJsonObject::ckStringOf(jResp,"owner.additionalLabel")
CommunityNickname.s = CkJsonObject::ckStringOf(jResp,"owner.communityNickname")
CompanyName.s = CkJsonObject::ckStringOf(jResp,"owner.companyName")
DisplayName.s = CkJsonObject::ckStringOf(jResp,"owner.displayName")
FirstName.s = CkJsonObject::ckStringOf(jResp,"owner.firstName")
Id.s = CkJsonObject::ckStringOf(jResp,"owner.id")
IsActive.i = CkJsonObject::ckBoolOf(jResp,"owner.isActive")
IsInThisCommunity.i = CkJsonObject::ckBoolOf(jResp,"owner.isInThisCommunity")
LastName.s = CkJsonObject::ckStringOf(jResp,"owner.lastName")
MotifColor.s = CkJsonObject::ckStringOf(jResp,"owner.motif.color")
MotifLargeIconUrl.s = CkJsonObject::ckStringOf(jResp,"owner.motif.largeIconUrl")
MotifMediumIconUrl.s = CkJsonObject::ckStringOf(jResp,"owner.motif.mediumIconUrl")
MotifSmallIconUrl.s = CkJsonObject::ckStringOf(jResp,"owner.motif.smallIconUrl")
MotifSvgIconUrl.s = CkJsonObject::ckStringOf(jResp,"owner.motif.svgIconUrl")
MySubscription.s = CkJsonObject::ckStringOf(jResp,"owner.mySubscription")
Name.s = CkJsonObject::ckStringOf(jResp,"owner.name")
Message.s = CkJsonObject::ckStringOf(jResp,"owner.outOfOffice.message")
FullEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"owner.photo.fullEmailPhotoUrl")
LargePhotoUrl.s = CkJsonObject::ckStringOf(jResp,"owner.photo.largePhotoUrl")
MediumPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"owner.photo.mediumPhotoUrl")
PhotoVersionId.s = CkJsonObject::ckStringOf(jResp,"owner.photo.photoVersionId")
SmallPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"owner.photo.smallPhotoUrl")
StandardEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"owner.photo.standardEmailPhotoUrl")
v_Url.s = CkJsonObject::ckStringOf(jResp,"owner.photo.url")
Reputation.s = CkJsonObject::ckStringOf(jResp,"owner.reputation")
Title.s = CkJsonObject::ckStringOf(jResp,"owner.title")
v_Type.s = CkJsonObject::ckStringOf(jResp,"owner.type")
ownerUrl.s = CkJsonObject::ckStringOf(jResp,"owner.url")
UserType.s = CkJsonObject::ckStringOf(jResp,"owner.userType")
pageCount.i = CkJsonObject::ckIntOf(jResp,"pageCount")
parentFolder.s = CkJsonObject::ckStringOf(jResp,"parentFolder")
pdfRenditionStatus.s = CkJsonObject::ckStringOf(jResp,"pdfRenditionStatus")
publishStatus.s = CkJsonObject::ckStringOf(jResp,"publishStatus")
renditionUrl.s = CkJsonObject::ckStringOf(jResp,"renditionUrl")
renditionUrl240By180.s = CkJsonObject::ckStringOf(jResp,"renditionUrl240By180")
renditionUrl720By480.s = CkJsonObject::ckStringOf(jResp,"renditionUrl720By480")
repositoryFileId.s = CkJsonObject::ckStringOf(jResp,"repositoryFileId")
repositoryFileUrl.s = CkJsonObject::ckStringOf(jResp,"repositoryFileUrl")
sharingOption.s = CkJsonObject::ckStringOf(jResp,"sharingOption")
sharingPrivacy.s = CkJsonObject::ckStringOf(jResp,"sharingPrivacy")
sharingRole.s = CkJsonObject::ckStringOf(jResp,"sharingRole")
systemModstamp.s = CkJsonObject::ckStringOf(jResp,"systemModstamp")
textPreview.s = CkJsonObject::ckStringOf(jResp,"textPreview")
thumb120By90RenditionStatus.s = CkJsonObject::ckStringOf(jResp,"thumb120By90RenditionStatus")
thumb240By180RenditionStatus.s = CkJsonObject::ckStringOf(jResp,"thumb240By180RenditionStatus")
thumb720By480RenditionStatus.s = CkJsonObject::ckStringOf(jResp,"thumb720By480RenditionStatus")
title.s = CkJsonObject::ckStringOf(jResp,"title")
CurrentPageUrl.s = CkJsonObject::ckStringOf(jResp,"topics.currentPageUrl")
NextPageUrl.s = CkJsonObject::ckStringOf(jResp,"topics.nextPageUrl")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
url.s = CkJsonObject::ckStringOf(jResp,"url")
versionNumber.s = CkJsonObject::ckStringOf(jResp,"versionNumber")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"topics.topics")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
