openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Information 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: Information paths: /data/v64.0/connect/files/{FILE_ID}: parameters: [] get: tags: - Information 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:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///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:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///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: - Information 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/sobjects/{SOBJECT_API_NAME}: parameters: [] get: tags: - Information summary: Salesforce Sobject Basic Information description: Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method. operationId: SObjectBasicInformation parameters: - name: SOBJECT_API_NAME in: path description: '' required: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value 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/commerce/catalog-products/actions/get-products: parameters: [] post: tags: - Information summary: Salesforce Request Product Information (no Bundles) description: 'Request information for two products that aren''t bundles. For the first product, request only the information about the specified product selling model. For the second product, request information about all related product selling models. See [Request Product Information](https://desktop.postman.com/?desktopVersion=10.13.6&webVersion=10.13.7-ui-230522-1730&userId=10709048&teamId=0).' operationId: RequestProductInformation(NoBundles) parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/RequestProductInformationNoBundlesRequest' - examples: - productContexts: - product2Id: '{{ClassTrainingProduct}}' productSellingModelId: '{{OneTimePSM}}' - product2Id: '{{VirtualRouterProduct}}' fields: - id - name - IsActive - ProductCode retrievalType: ExcludeChildComponents contentMediaType: application/json example: productContexts: - product2Id: '{{ClassTrainingProduct}}' productSellingModelId: '{{OneTimePSM}}' - product2Id: '{{VirtualRouterProduct}}' fields: - id - name - IsActive - ProductCode retrievalType: ExcludeChildComponents required: true 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 components: schemas: Topics: title: Topics required: - currentPageUrl - nextPageUrl - topics type: object properties: currentPageUrl: type: - string - 'null' example: https://www.example.com nextPageUrl: type: - string - 'null' example: https://www.example.com topics: type: array items: type: string description: '' example: [] examples: - currentPageUrl: null nextPageUrl: null topics: [] Photo: title: Photo required: - fullEmailPhotoUrl - largePhotoUrl - mediumPhotoUrl - photoVersionId - smallPhotoUrl - standardEmailPhotoUrl - url type: object properties: fullEmailPhotoUrl: type: string example: user@example.com largePhotoUrl: type: string example: https://www.example.com mediumPhotoUrl: type: string example: https://www.example.com photoVersionId: type: string example: '500123' smallPhotoUrl: type: string example: https://www.example.com standardEmailPhotoUrl: type: string example: user@example.com url: type: string example: https://www.example.com examples: - fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo RequestProductInformationNoBundlesRequest: title: RequestProductInformationNoBundlesRequest required: - productContexts - fields - retrievalType type: object properties: productContexts: type: array items: $ref: '#/components/schemas/ProductContext' description: '' example: [] fields: type: array items: type: string description: '' example: [] retrievalType: type: string example: example_value examples: - productContexts: - product2Id: '{{ClassTrainingProduct}}' productSellingModelId: '{{OneTimePSM}}' - product2Id: '{{VirtualRouterProduct}}' fields: - id - name - IsActive - ProductCode retrievalType: ExcludeChildComponents Owner: title: Owner required: - additionalLabel - communityNickname - companyName - displayName - firstName - id - isActive - isInThisCommunity - lastName - motif - mySubscription - name - outOfOffice - photo - reputation - title - type - url - userType type: object properties: additionalLabel: type: - string - 'null' example: example_value communityNickname: type: string example: example_value companyName: type: string example: example_value displayName: type: string example: example_value firstName: type: string example: example_value id: type: string example: abc123 isActive: type: boolean example: true isInThisCommunity: type: boolean example: true lastName: type: string example: example_value motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title outOfOffice: $ref: '#/components/schemas/OutOfOffice' photo: $ref: '#/components/schemas/Photo' reputation: type: - string - 'null' example: example_value title: type: - string - 'null' example: Example Title type: type: string example: example_value url: type: string example: https://www.example.com userType: type: string example: example_value examples: - 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:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///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 ProductContext: title: ProductContext required: - product2Id type: object properties: product2Id: type: string example: '500123' productSellingModelId: type: string example: '500123' examples: - product2Id: '{{ClassTrainingProduct}}' productSellingModelId: '{{OneTimePSM}}' FileInformation: title: FileInformation required: - checksum - contentHubRepository - contentModifiedDate - contentSize - contentUrl - createdDate - description - downloadUrl - externalDocumentUrl - externalFilePermissionInformation - fileAsset - fileExtension - fileType - flashRenditionStatus - id - isFileAsset - isInMyFileSync - isMajorVersion - mimeType - moderationFlags - modifiedDate - motif - mySubscription - name - origin - owner - pageCount - parentFolder - pdfRenditionStatus - publishStatus - renditionUrl - renditionUrl240By180 - renditionUrl720By480 - repositoryFileId - repositoryFileUrl - sharingOption - sharingPrivacy - sharingRole - systemModstamp - textPreview - thumb120By90RenditionStatus - thumb240By180RenditionStatus - thumb720By480RenditionStatus - title - topics - type - url - versionNumber type: object properties: checksum: type: string example: example_value contentHubRepository: type: - string - 'null' example: example_value contentModifiedDate: type: string example: example_value contentSize: type: integer contentEncoding: int32 example: 10 contentUrl: type: - string - 'null' example: https://www.example.com createdDate: type: string example: example_value description: type: - string - 'null' example: A sample description. downloadUrl: type: string example: https://www.example.com externalDocumentUrl: type: - string - 'null' example: https://www.example.com externalFilePermissionInformation: type: - string - 'null' example: example_value fileAsset: type: - string - 'null' example: example_value fileExtension: type: string example: example_value fileType: type: string example: example_value flashRenditionStatus: type: string example: example_value id: type: string example: abc123 isFileAsset: type: boolean example: true isInMyFileSync: type: boolean example: true isMajorVersion: type: boolean example: true mimeType: type: string example: example_value moderationFlags: type: - string - 'null' example: example_value modifiedDate: type: string example: example_value motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title origin: type: string example: example_value owner: $ref: '#/components/schemas/Owner' pageCount: type: integer contentEncoding: int32 example: 42 parentFolder: type: - string - 'null' example: example_value pdfRenditionStatus: type: string example: example_value publishStatus: type: string example: example_value renditionUrl: type: string example: https://www.example.com renditionUrl240By180: type: string example: https://www.example.com renditionUrl720By480: type: string example: https://www.example.com repositoryFileId: type: - string - 'null' example: '500123' repositoryFileUrl: type: - string - 'null' example: https://www.example.com sharingOption: type: string example: example_value sharingPrivacy: type: string example: example_value sharingRole: type: string example: example_value systemModstamp: type: string example: example_value textPreview: type: - string - 'null' example: example_value thumb120By90RenditionStatus: type: string example: example_value thumb240By180RenditionStatus: type: string example: example_value thumb720By480RenditionStatus: type: string example: example_value title: type: string example: Example Title topics: $ref: '#/components/schemas/Topics' type: type: string example: example_value url: type: string example: https://www.example.com versionNumber: type: string example: example_value 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:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///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' Motif: title: Motif required: - color - largeIconUrl - mediumIconUrl - smallIconUrl - svgIconUrl type: object properties: color: type: string example: example_value largeIconUrl: type: string example: https://www.example.com mediumIconUrl: type: string example: https://www.example.com smallIconUrl: type: string example: https://www.example.com svgIconUrl: type: - string - 'null' example: https://www.example.com examples: - color: '939393' largeIconUrl: /img/content/content64.png mediumIconUrl: /img/content/content32.png smallIconUrl: /img/icon/files16.png svgIconUrl: null OutOfOffice: title: OutOfOffice required: - message type: object properties: message: type: string example: example_value examples: - message: '' securitySchemes: BearerAuth: type: http scheme: bearer description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}". '