Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let req = CkoHttpRequest()
req.HttpVerb = "POST"
req.Path = "/services/data/v{{version}}/connect/files/users/me"
req.ContentType = "multipart/form-data"
success = req.AddFileForUpload2("fileData", path: " path to file", contentType: "application/octet-stream")
req.AddHeader("Authorization", value: "Bearer <access_token>")
req.AddHeader("Expect", value: "100-continue")
var resp: CkoHttpResponse? = http.SynchronousRequest("domain.com", port: 443, ssl: true, req: req)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var checksum: String? = jResp.StringOf("checksum")
var contentHubRepository: String? = jResp.StringOf("contentHubRepository")
var contentModifiedDate: String? = jResp.StringOf("contentModifiedDate")
var contentSize: Int = jResp.IntOf("contentSize").intValue
var contentUrl: String? = jResp.StringOf("contentUrl")
var createdDate: String? = jResp.StringOf("createdDate")
var description: String? = jResp.StringOf("description")
var downloadUrl: String? = jResp.StringOf("downloadUrl")
var externalDocumentUrl: String? = jResp.StringOf("externalDocumentUrl")
var externalFilePermissionInformation: String? = jResp.StringOf("externalFilePermissionInformation")
var fileAsset: String? = jResp.StringOf("fileAsset")
var fileExtension: String? = jResp.StringOf("fileExtension")
var fileType: String? = jResp.StringOf("fileType")
var flashRenditionStatus: String? = jResp.StringOf("flashRenditionStatus")
var id: String? = jResp.StringOf("id")
var isFileAsset: Bool = jResp.BoolOf("isFileAsset")
var isInMyFileSync: Bool = jResp.BoolOf("isInMyFileSync")
var isMajorVersion: Bool = jResp.BoolOf("isMajorVersion")
var mimeType: String? = jResp.StringOf("mimeType")
var moderationFlags: String? = jResp.StringOf("moderationFlags")
var modifiedDate: String? = jResp.StringOf("modifiedDate")
var Color: String? = jResp.StringOf("motif.color")
var LargeIconUrl: String? = jResp.StringOf("motif.largeIconUrl")
var MediumIconUrl: String? = jResp.StringOf("motif.mediumIconUrl")
var SmallIconUrl: String? = jResp.StringOf("motif.smallIconUrl")
var SvgIconUrl: String? = jResp.StringOf("motif.svgIconUrl")
var mySubscription: String? = jResp.StringOf("mySubscription")
var name: String? = jResp.StringOf("name")
var origin: String? = jResp.StringOf("origin")
var AdditionalLabel: String? = jResp.StringOf("owner.additionalLabel")
var CommunityNickname: String? = jResp.StringOf("owner.communityNickname")
var CompanyName: String? = jResp.StringOf("owner.companyName")
var DisplayName: String? = jResp.StringOf("owner.displayName")
var FirstName: String? = jResp.StringOf("owner.firstName")
var Id: String? = jResp.StringOf("owner.id")
var IsActive: Bool = jResp.BoolOf("owner.isActive")
var IsInThisCommunity: Bool = jResp.BoolOf("owner.isInThisCommunity")
var LastName: String? = jResp.StringOf("owner.lastName")
var MotifColor: String? = jResp.StringOf("owner.motif.color")
var MotifLargeIconUrl: String? = jResp.StringOf("owner.motif.largeIconUrl")
var MotifMediumIconUrl: String? = jResp.StringOf("owner.motif.mediumIconUrl")
var MotifSmallIconUrl: String? = jResp.StringOf("owner.motif.smallIconUrl")
var MotifSvgIconUrl: String? = jResp.StringOf("owner.motif.svgIconUrl")
var MySubscription: String? = jResp.StringOf("owner.mySubscription")
var Name: String? = jResp.StringOf("owner.name")
var Message: String? = jResp.StringOf("owner.outOfOffice.message")
var FullEmailPhotoUrl: String? = jResp.StringOf("owner.photo.fullEmailPhotoUrl")
var LargePhotoUrl: String? = jResp.StringOf("owner.photo.largePhotoUrl")
var MediumPhotoUrl: String? = jResp.StringOf("owner.photo.mediumPhotoUrl")
var PhotoVersionId: String? = jResp.StringOf("owner.photo.photoVersionId")
var SmallPhotoUrl: String? = jResp.StringOf("owner.photo.smallPhotoUrl")
var StandardEmailPhotoUrl: String? = jResp.StringOf("owner.photo.standardEmailPhotoUrl")
var v_Url: String? = jResp.StringOf("owner.photo.url")
var Reputation: String? = jResp.StringOf("owner.reputation")
var Title: String? = jResp.StringOf("owner.title")
var v_Type: String? = jResp.StringOf("owner.type")
var ownerUrl: String? = jResp.StringOf("owner.url")
var UserType: String? = jResp.StringOf("owner.userType")
var pageCount: Int = jResp.IntOf("pageCount").intValue
var parentFolder: String? = jResp.StringOf("parentFolder")
var pdfRenditionStatus: String? = jResp.StringOf("pdfRenditionStatus")
var publishStatus: String? = jResp.StringOf("publishStatus")
var renditionUrl: String? = jResp.StringOf("renditionUrl")
var renditionUrl240By180: String? = jResp.StringOf("renditionUrl240By180")
var renditionUrl720By480: String? = jResp.StringOf("renditionUrl720By480")
var repositoryFileId: String? = jResp.StringOf("repositoryFileId")
var repositoryFileUrl: String? = jResp.StringOf("repositoryFileUrl")
var sharingOption: String? = jResp.StringOf("sharingOption")
var sharingPrivacy: String? = jResp.StringOf("sharingPrivacy")
var sharingRole: String? = jResp.StringOf("sharingRole")
var systemModstamp: String? = jResp.StringOf("systemModstamp")
var textPreview: String? = jResp.StringOf("textPreview")
var thumb120By90RenditionStatus: String? = jResp.StringOf("thumb120By90RenditionStatus")
var thumb240By180RenditionStatus: String? = jResp.StringOf("thumb240By180RenditionStatus")
var thumb720By480RenditionStatus: String? = jResp.StringOf("thumb720By480RenditionStatus")
var title: String? = jResp.StringOf("title")
var CurrentPageUrl: String? = jResp.StringOf("topics.currentPageUrl")
var NextPageUrl: String? = jResp.StringOf("topics.nextPageUrl")
var v_type: String? = jResp.StringOf("type")
var url: String? = jResp.StringOf("url")
var versionNumber: String? = jResp.StringOf("versionNumber")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("topics.topics").intValue
while i < count_i {
jResp.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}"
}
]
}
