openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Files API
description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.
'
version: v63.0
contact:
name: Salesforce Developers
url: https://developer.salesforce.com/
license:
name: Salesforce Developer Terms
url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
description: Salesforce Bulk API 2.0 jobs endpoint
variables:
instance:
default: yourInstance
description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).
'
version:
default: '63.0'
description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.
'
security:
- BearerAuth: []
tags:
- name: Files
paths:
/data/v64.0/connect/files/users/me:
parameters: []
post:
tags:
- Files
summary: Salesforce Users Files, General
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.
When you upload a file to the Files home, it is private and available only to the file owner.
To 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.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_files_general.htm'
operationId: UsersFiles,General
parameters: []
requestBody:
content:
multipart/form-data:
encoding: {}
schema:
required:
- fileData
type: object
properties:
fileData:
type: string
contentEncoding: base64
contentMediaType: multipart/form-data
examples:
Usersfiles,generalRequestExample:
summary: Default UsersFiles,General request
x-microcks-default: true
value:
fileData: example_value
required: false
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:28:22 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/SuccessfulUsersFilesGeneral'
- examples:
- checksum: 71a50dbba44c78128b221b7df7bb51f1
contentHubRepository: null
contentModifiedDate: '2023-11-20T16:28:22.000Z'
contentSize: 95
contentUrl: null
contentVersionId: 068xx0000004C92AAE
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'
contentMediaType: application/json;charset=UTF-8
example:
checksum: 71a50dbba44c78128b221b7df7bb51f1
contentHubRepository: null
contentModifiedDate: '2023-11-20T16:28:22.000Z'
contentSize: 95
contentUrl: null
contentVersionId: 068xx0000004C92AAE
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'
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/connect/files/{FILE_ID}:
parameters: []
get:
tags:
- Files
summary: Salesforce File Information
description: 'Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.
To upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See Uploading Binary Files. To upload a new file to the Files home, use /connect/files/users/me.Get information about a specified file, including references to external files.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_information.htm'
operationId: FileInformation
parameters:
- name: FILE_ID
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:33:38 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/FileInformation'
- examples:
- 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'
contentMediaType: application/json;charset=UTF-8
example:
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'
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Files
summary: Salesforce File Information - Delete
description: 'Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.
To upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See Uploading Binary Files. To upload a new file to the Files home, use /connect/files/users/me.Get information about a specified file, including references to external files.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_information.htm'
operationId: FileInformation-Delete
parameters:
- name: FILE_ID
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'204':
description: No Content
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:39:05 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
Content-Security-Policy:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: upgrade-insecure-requests
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
content: {}
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/connect/files/{FILE_ID}/content:
parameters: []
get:
tags:
- Files
summary: Salesforce File Content
description: 'Returns the binary content of the file, including references to external files. The content is streamed as the body of the response.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_content.htm'
operationId: FileContent
parameters:
- name: FILE_ID
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: ''
headers: {}
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/connect/files/{FILE_ID}/file-shares:
parameters: []
get:
tags:
- Files
summary: Salesforce File Shares
description: 'Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm'
operationId: FileShares
parameters:
- name: FILE_ID
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:37:07 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: strin
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-files-api-openapi.yml