openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Versions 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: Versions paths: /data/v64.0/connect/business-rules/expression-set/version/{expressionSetVersionId}/dependencies: parameters: [] get: tags: - Versions summary: Salesforce Retrieve Expression Set Version Dependencies description: "[https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm)\n\n# Expression Set Version Dependencies (GET)\n\nRetrieve expression set version dependencies.Resource\n\n```\n/connect/business-rules/expression-set/version/${expressionSetVersionId}/dependencies\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v58.0/connect/business-rules/expression-set/version/9QARN000000016v4AA/dependencies\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Expression Set Version Dependency](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_version_dependency_output.htm)" operationId: Retrieveexpressionsetversiondependencies parameters: - name: expressionSetVersionId in: path description: 'Expression Set Version Id: For Example 9QLHo000000LBjEOAW' required: true schema: type: string examples: - 9QMHo000000LBnbOAG example: '500123' responses: '400': description: Bad Request headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:28:18 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status400-BadRequest1' description: '' examples: - - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' contentMediaType: application/json;charset=UTF-8 example: - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' '404': description: Not Found headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:29:34 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status404-RecordNotFound1' description: '' examples: - - errorCode: NOT_FOUND message: The requested resource does not exist contentMediaType: application/json;charset=UTF-8 example: - errorCode: NOT_FOUND message: The requested resource does not exist '500': description: Server Error headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:26:46 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status500-UnexpectedError1' description: '' examples: - - errorCode: INTERNAL_ERROR message: Unexpected Error contentMediaType: application/json;charset=UTF-8 example: - errorCode: INTERNAL_ERROR message: Unexpected Error deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data: parameters: [] get: tags: - Versions summary: Salesforce Versions description: Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root. operationId: Versions parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value - name: Sforce-Call-Options in: header description: '' required: true schema: type: string examples: - client=postman example: example_value responses: default: description: '' headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Version5' description: '' examples: - - label: Spring '11 url: /services/data/v21.0 version: '21.0' - label: Summer '11 url: /services/data/v22.0 version: '22.0' - label: Winter '12 url: /services/data/v23.0 version: '23.0' - label: Spring '12 url: /services/data/v24.0 version: '24.0' - label: Summer '12 url: /services/data/v25.0 version: '25.0' - label: Winter '13 url: /services/data/v26.0 version: '26.0' - label: Spring '13 url: /services/data/v27.0 version: '27.0' - label: Summer '13 url: /services/data/v28.0 version: '28.0' - label: Winter '14 url: /services/data/v29.0 version: '29.0' - label: Spring '14 url: /services/data/v30.0 version: '30.0' - label: Summer '14 url: /services/data/v31.0 version: '31.0' - label: Winter '15 url: /services/data/v32.0 version: '32.0' - label: Spring '15 url: /services/data/v33.0 version: '33.0' - label: Summer '15 url: /services/data/v34.0 version: '34.0' - label: Winter '16 url: /services/data/v35.0 version: '35.0' - label: Spring '16 url: /services/data/v36.0 version: '36.0' - label: Summer '16 url: /services/data/v37.0 version: '37.0' - label: Winter '17 url: /services/data/v38.0 version: '38.0' - label: Spring '17 url: /services/data/v39.0 version: '39.0' - label: Summer '17 url: /services/data/v40.0 version: '40.0' - label: Winter '18 url: /services/data/v41.0 version: '41.0' - label: Spring ’18 url: /services/data/v42.0 version: '42.0' - label: Summer '18 url: /services/data/v43.0 version: '43.0' - label: Winter '19 url: /services/data/v44.0 version: '44.0' - label: Spring '19 url: /services/data/v45.0 version: '45.0' - label: Summer '19 url: /services/data/v46.0 version: '46.0' - label: Winter '20 url: /services/data/v47.0 version: '47.0' - label: Spring '20 url: /services/data/v48.0 version: '48.0' - label: Summer '20 url: /services/data/v49.0 version: '49.0' - label: Winter '21 url: /services/data/v50.0 version: '50.0' - label: Spring '21 url: /services/data/v51.0 version: '51.0' - label: Summer '21 url: /services/data/v52.0 version: '52.0' - label: Winter '22 url: /services/data/v53.0 version: '53.0' contentMediaType: application/json example: - label: Spring '11 url: /services/data/v21.0 version: '21.0' - label: Summer '11 url: /services/data/v22.0 version: '22.0' - label: Winter '12 url: /services/data/v23.0 version: '23.0' - label: Spring '12 url: /services/data/v24.0 version: '24.0' - label: Summer '12 url: /services/data/v25.0 version: '25.0' - label: Winter '13 url: /services/data/v26.0 version: '26.0' - label: Spring '13 url: /services/data/v27.0 version: '27.0' - label: Summer '13 url: /services/data/v28.0 version: '28.0' - label: Winter '14 url: /services/data/v29.0 version: '29.0' - label: Spring '14 url: /services/data/v30.0 version: '30.0' - label: Summer '14 url: /services/data/v31.0 version: '31.0' - label: Winter '15 url: /services/data/v32.0 version: '32.0' - label: Spring '15 url: /services/data/v33.0 version: '33.0' - label: Summer '15 url: /services/data/v34.0 version: '34.0' - label: Winter '16 url: /services/data/v35.0 version: '35.0' - label: Spring '16 url: /services/data/v36.0 version: '36.0' - label: Summer '16 url: /services/data/v37.0 version: '37.0' - label: Winter '17 url: /services/data/v38.0 version: '38.0' - label: Spring '17 url: /services/data/v39.0 version: '39.0' - label: Summer '17 url: /services/data/v40.0 version: '40.0' - label: Winter '18 url: /services/data/v41.0 version: '41.0' - label: Spring ’18 url: /services/data/v42.0 version: '42.0' - label: Summer '18 url: /services/data/v43.0 version: '43.0' - label: Winter '19 url: /services/data/v44.0 version: '44.0' - label: Spring '19 url: /services/data/v45.0 version: '45.0' - label: Summer '19 url: /services/data/v46.0 version: '46.0' - label: Winter '20 url: /services/data/v47.0 version: '47.0' - label: Spring '20 url: /services/data/v48.0 version: '48.0' - label: Summer '20 url: /services/data/v49.0 version: '49.0' - label: Winter '21 url: /services/data/v50.0 version: '50.0' - label: Spring '21 url: /services/data/v51.0 version: '51.0' - label: Summer '21 url: /services/data/v52.0 version: '52.0' - label: Winter '22 url: /services/data/v53.0 version: '53.0' deprecated: false security: [] servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0: parameters: [] get: tags: - Versions summary: Salesforce Resources by Version description: Lists available resources for the specified API version, including resource name and URI. operationId: ResourcesbyVersion parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Tue, 26 Sep 2023 13:29:43 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 Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=3/15000 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/ResourcesbyVersion' - examples: - tooling: /services/data/v58.0/tooling metadata: /services/data/v58.0/metadata eclair: /services/data/v58.0/eclair folders: /services/data/v58.0/folders prechatForms: /services/data/v58.0/prechatForms contact-tracing: /services/data/v58.0/contact-tracing jsonxform: /services/data/v58.0/jsonxform chatter: /services/data/v58.0/chatter payments: /services/data/v58.0/payments tabs: /services/data/v58.0/tabs appMenu: /services/data/v58.0/appMenu quickActions: /services/data/v58.0/quickActions queryAll: /services/data/v58.0/queryAll commerce: /services/data/v58.0/commerce wave: /services/data/v58.0/wave iot: /services/data/v58.0/iot analytics: /services/data/v58.0/analytics search: /services/data/v58.0/search smartdatadiscovery: /services/data/v58.0/smartdatadiscovery identity: https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO composite: /services/data/v58.0/composite parameterizedSearch: /services/data/v58.0/parameterizedSearch fingerprint: /services/data/v58.0/fingerprint theme: /services/data/v58.0/theme nouns: /services/data/v58.0/nouns domino: /services/data/v58.0/domino event: /services/data/v58.0/event serviceTemplates: /services/data/v58.0/serviceTemplates recent: /services/data/v58.0/recent connect: /services/data/v58.0/connect licensing: /services/data/v58.0/licensing limits: /services/data/v58.0/limits process: /services/data/v58.0/process dedupe: /services/data/v58.0/dedupe async-queries: /services/data/v58.0/async-queries query: /services/data/v58.0/query jobs: /services/data/v58.0/jobs match: /services/data/v58.0/match localizedvalue: /services/data/v58.0/localizedvalue mobile: /services/data/v58.0/mobile emailConnect: /services/data/v58.0/emailConnect consent: /services/data/v58.0/consent tokenizer: /services/data/v58.0/tokenizer compactLayouts: /services/data/v58.0/compactLayouts knowledgeManagement: /services/data/v58.0/knowledgeManagement sobjects: /services/data/v58.0/sobjects actions: /services/data/v58.0/actions support: /services/data/v58.0/support contentMediaType: application/json;charset=UTF-8 example: tooling: /services/data/v58.0/tooling metadata: /services/data/v58.0/metadata eclair: /services/data/v58.0/eclair folders: /services/data/v58.0/folders prechatForms: /services/data/v58.0/prechatForms contact-tracing: /services/data/v58.0/contact-tracing jsonxform: /services/data/v58.0/jsonxform chatter: /services/data/v58.0/chatter payments: /services/data/v58.0/payments tabs: /services/data/v58.0/tabs appMenu: /services/data/v58.0/appMenu quickActions: /services/data/v58.0/quickActions queryAll: /services/data/v58.0/queryAll commerce: /services/data/v58.0/commerce wave: /services/data/v58.0/wave iot: /services/data/v58.0/iot analytics: /services/data/v58.0/analytics search: /services/data/v58.0/search smartdatadiscovery: /services/data/v58.0/smartdatadiscovery identity: https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO composite: /services/data/v58.0/composite parameterizedSearch: /services/data/v58.0/parameterizedSearch fingerprint: /services/data/v58.0/fingerprint theme: /services/data/v58.0/theme nouns: /services/data/v58.0/nouns domino: /services/data/v58.0/domino event: /services/data/v58.0/event serviceTemplates: /services/data/v58.0/serviceTemplates recent: /services/data/v58.0/recent connect: /services/data/v58.0/connect licensing: /services/data/v58.0/licensing limits: /services/data/v58.0/limits process: /services/data/v58.0/process dedupe: /services/data/v58.0/dedupe async-queries: /services/data/v58.0/async-queries query: /services/data/v58.0/query jobs: /services/data/v58.0/jobs match: /services/data/v58.0/match localizedvalue: /services/data/v58.0/localizedvalue mobile: /services/data/v58.0/mobile emailConnect: /services/data/v58.0/emailConnect consent: /services/data/v58.0/consent tokenizer: /services/data/v58.0/tokenizer compactLayouts: /services/data/v58.0/compactLayouts knowledgeManagement: /services/data/v58.0/knowledgeManagement sobjects: /services/data/v58.0/sobjects actions: /services/data/v58.0/actions support: /services/data/v58.0/support deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /: get: operationId: listApiVersions summary: Salesforce List Available Api Versions description: 'Returns a list of all Salesforce REST API versions available on this instance. Each entry includes the version number, label, and URL. Use this to discover the latest supported version before building integrations. ' tags: - Versions responses: '200': description: A list of available API versions. content: application/json: schema: type: array items: $ref: '#/components/schemas/ApiVersion' examples: Listapiversions200Example: summary: Default listApiVersions 200 response x-microcks-default: true value: - version: example_value label: Example Title url: https://www.example.com '401': description: Unauthorized. Invalid or expired OAuth token. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Listapiversions401Example: summary: Default listApiVersions 401 response x-microcks-default: true value: message: example_value errorCode: example_value fields: - example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Version5: title: Version5 required: - label - url - version type: object properties: label: type: string example: Example Title url: type: string example: https://www.example.com version: type: string example: example_value examples: - label: Spring '11 url: /services/data/v21.0 version: '21.0' Error: type: object description: 'An error response from the Salesforce REST API, describing the problem with the request. ' properties: message: type: string description: Human-readable description of the error. example: example_value errorCode: type: string description: 'Salesforce error code (e.g., MALFORMED_QUERY, INVALID_FIELD, REQUIRED_FIELD_MISSING). ' example: example_value fields: type: array description: 'List of field names related to the error, if applicable (e.g., for field validation errors). ' items: type: string example: [] Status400-BadRequest1: title: Status400-BadRequest1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' Status500-UnexpectedError1: title: Status500-UnexpectedError1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: INTERNAL_ERROR message: Unexpected Error Status404-RecordNotFound1: title: Status404-RecordNotFound1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: NOT_FOUND message: The requested resource does not exist ResourcesbyVersion: title: ResourcesbyVersion required: - tooling - metadata - eclair - folders - prechatForms - contact-tracing - jsonxform - chatter - payments - tabs - appMenu - quickActions - queryAll - commerce - wave - iot - analytics - search - smartdatadiscovery - identity - composite - parameterizedSearch - fingerprint - theme - nouns - domino - event - serviceTemplates - recent - connect - licensing - limits - process - dedupe - async-queries - query - jobs - match - localizedvalue - mobile - emailConnect - consent - tokenizer - compactLayouts - knowledgeManagement - sobjects - actions - support type: object properties: tooling: type: string example: example_value metadata: type: string example: example_value eclair: type: string example: example_value folders: type: string example: example_value prechatForms: type: string example: example_value contact-tracing: type: string example: example_value jsonxform: type: string example: example_value chatter: type: string example: example_value payments: type: string example: example_value tabs: type: string example: example_value appMenu: type: string example: example_value quickActions: type: string example: example_value queryAll: type: string example: example_value commerce: type: string example: example_value wave: type: string example: example_value iot: type: string example: example_value analytics: type: string example: example_value search: type: string example: example_value smartdatadiscovery: type: string example: example_value identity: type: string example: example_value composite: type: string example: example_value parameterizedSearch: type: string example: example_value fingerprint: type: string example: example_value theme: type: string example: example_value nouns: type: string example: example_value domino: type: string example: example_value event: type: string example: example_value serviceTemplates: type: string example: example_value recent: type: string example: example_value connect: type: string example: example_value licensing: type: string example: example_value limits: type: string example: example_value process: type: string example: example_value dedupe: type: string example: example_value async-queries: type: string example: example_value query: type: string example: example_value jobs: type: string example: example_value match: type: string example: example_value localizedvalue: type: string example: example_value mobile: type: string example: example_value emailConnect: type: string example: user@example.com consent: type: string example: example_value tokenizer: type: string example: CAUQAA compactLayouts: type: string example: example_value knowledgeManagement: type: string example: example_value sobjects: type: string example: example_value actions: type: string example: example_value support: type: string example: example_value examples: - tooling: /services/data/v58.0/tooling metadata: /services/data/v58.0/metadata eclair: /services/data/v58.0/eclair folders: /services/data/v58.0/folders prechatForms: /services/data/v58.0/prechatForms contact-tracing: /services/data/v58.0/contact-tracing jsonxform: /services/data/v58.0/jsonxform chatter: /services/data/v58.0/chatter payments: /services/data/v58.0/payments tabs: /services/data/v58.0/tabs appMenu: /services/data/v58.0/appMenu quickActions: /services/data/v58.0/quickActions queryAll: /services/data/v58.0/queryAll commerce: /services/data/v58.0/commerce wave: /services/data/v58.0/wave iot: /services/data/v58.0/iot analytics: /services/data/v58.0/analytics search: /services/data/v58.0/search smartdatadiscovery: /services/data/v58.0/smartdatadiscovery identity: https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO composite: /services/data/v58.0/composite parameterizedSearch: /services/data/v58.0/parameterizedSearch fingerprint: /services/data/v58.0/fingerprint theme: /services/data/v58.0/theme nouns: /services/data/v58.0/nouns domino: /services/data/v58.0/domino event: /services/data/v58.0/event serviceTemplates: /services/data/v58.0/serviceTemplates recent: /services/data/v58.0/recent connect: /services/data/v58.0/connect licensing: /services/data/v58.0/licensing limits: /services/data/v58.0/limits process: /services/data/v58.0/process dedupe: /services/data/v58.0/dedupe async-queries: /services/data/v58.0/async-queries query: /services/data/v58.0/query jobs: /services/data/v58.0/jobs match: /services/data/v58.0/match localizedvalue: /services/data/v58.0/localizedvalue mobile: /services/data/v58.0/mobile emailConnect: /services/data/v58.0/emailConnect consent: /services/data/v58.0/consent tokenizer: /services/data/v58.0/tokenizer compactLayouts: /services/data/v58.0/compactLayouts knowledgeManagement: /services/data/v58.0/knowledgeManagement sobjects: /services/data/v58.0/sobjects actions: /services/data/v58.0/actions support: /services/data/v58.0/support ApiVersion: type: object description: 'Metadata about a single available Salesforce REST API version on this instance. ' properties: version: type: string description: The API version number (e.g., "63.0"). example: example_value label: type: string description: Descriptive label for this API version (e.g., "Winter '25"). example: Example Title url: type: string format: uri description: 'The REST endpoint URL for this specific API version on the current instance. ' example: https://www.example.com 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}". '