openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Queries 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: Queries paths: /data/v64.0/jobs/query/: parameters: [] get: tags: - Queries summary: Salesforce Get Job Info Query operationId: GetJobInfoQuery parameters: [] responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Fri, 17 Nov 2023 16:13: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=2/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/SuccessfulGetJobInfoQuery' - examples: - id: 750... operation: insert object: Account createdById: 005... createdDate: systemModstamp: state: Open concurrencyMode: Parallel contentType: CSV apiVersion: 58 jobType: Classic retries: 0 totalProcessingTime: 0 apiActiveProcessingTime: 0 apexProcessingTime: 0 contentMediaType: application/json;charset=UTF-8 example: id: 750... operation: insert object: Account createdById: 005... createdDate: systemModstamp: state: Open concurrencyMode: Parallel contentType: CSV apiVersion: 58 jobType: Classic retries: 0 totalProcessingTime: 0 apiActiveProcessingTime: 0 apexProcessingTime: 0 deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Queries summary: Salesforce Abort a Job Query operationId: AbortaJobQuery parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AbortaJobQueryRequest' - examples: - state: Aborted contentMediaType: application/json example: state: Aborted required: true responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 15:10:26 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=29/15000 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/AbortaJobQuery' - examples: - id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: Aborted concurrencyMode: Parallel contentType: CSV apiVersion: 58 contentMediaType: application/json;charset=UTF-8 example: id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: Aborted concurrencyMode: Parallel contentType: CSV apiVersion: 58 deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Queries summary: Salesforce Delete Job Query operationId: DeleteJobQuery parameters: [] responses: '204': description: No Content headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 15:08:40 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 Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=23/15000 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/jobs/query//results: parameters: [] get: tags: - Queries summary: Salesforce Get Job Query Result operationId: GetJobQueryResult parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value - name: Accept in: header description: '' required: true schema: type: string examples: - test/csv 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/jobs/query: parameters: [] get: tags: - Queries summary: Salesforce Get All Query Jobs operationId: GetAllQueryJobs parameters: - name: isPkChunkingEnabled in: query description: If set to true, the request only returns information about jobs where PK Chunking is enabled required: true style: form explode: true schema: type: boolean examples: - false example: true - name: jobType in: query description: BigObjectIngest Classic V2Query required: true style: form explode: true schema: type: string example: example_value - name: concurrencyMode in: query description: serial parallel required: true style: form explode: true schema: type: string example: example_value - name: queryLocator in: query description: use the value from the nextRecordsUrl from the previous set required: true style: form explode: 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: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Fri, 17 Nov 2023 16:25:06 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=4/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: type: string examples: - "{\n \"done\": true,\n \"nextRecordsUrl\": null,\n \"records\": [\n {\n \"id\": \"750...\",\n \"operation\": \"insert\",\n \"object\": \"Account\",\n \"createdById\": \"005...\",\n \"createdDate\": \"\",\n \"systemModstamp\": \"\",\n \"state\": \"Open\",\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"apiVersion\": 58,\n \"jobType\": \"Classic\"\n },...\n ]\n}" contentMediaType: application/json;charset=UTF-8 example: "{\n \"done\": true,\n \"nextRecordsUrl\": null,\n \"records\": [\n {\n \"id\": \"750...\",\n \"operation\": \"insert\",\n \"object\": \"Account\",\n \"createdById\": \"005...\",\n \"createdDate\": \"\",\n \"systemModstamp\": \"\",\n \"state\": \"Open\",\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"apiVersion\": 58,\n \"jobType\": \"Classic\"\n },...\n ]\n}" deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Queries summary: Salesforce Successful Create Job Query operationId: SuccessfulCreatejobQuery parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessfulCreatejobQueryRequest' - examples: - operation: query query: SELECT fields FROM object WHERE filter contentType: CSV columnDelimiter: BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB lineEnding: CRLF | LF contentMediaType: application/json example: operation: query query: SELECT fields FROM object WHERE filter contentType: CSV columnDelimiter: BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB lineEnding: CRLF | LF required: true responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 15:06:06 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=18/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/SuccessfulCreatejobQuery' - examples: - id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: UploadComplete concurrencyMode: Parallel contentType: CSV apiVersion: 58 lineEnding: LF columnDelimiter: COMMA contentMediaType: application/json;charset=UTF-8 example: id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: UploadComplete concurrencyMode: Parallel contentType: CSV apiVersion: 58 lineEnding: LF columnDelimiter: COMMA 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/jobs/query//resultPages: parameters: [] get: tags: - Queries summary: Salesforce Get Parallel Results for a Query Job description: Retrieves a set of up to 5 job results pages for parallel download. operationId: GetParallelResultsforaQueryJob parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value - name: Accept in: header description: '' required: true schema: type: string examples: - application/json example: example_value responses: default: description: '' headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/GetParallelResultsforaQueryJob' - examples: - resultPages: - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N done: false contentMediaType: application/json example: resultPages: - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N done: false 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/search/suggestSearchQueries: parameters: [] get: tags: - Queries summary: Salesforce Search Suggested Queries description: 'Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm' operationId: SearchSuggestedQueries parameters: - name: q in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: language in: query description: '' required: true style: form explode: 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 components: schemas: AbortaJobQuery: title: AbortaJobQuery required: - id - operation - object - createdById - createdDate - systemModstamp - state - concurrencyMode - contentType - apiVersion type: object properties: id: type: string example: abc123 operation: type: string example: example_value object: type: string example: example_value createdById: type: string example: '500123' createdDate: type: string example: example_value systemModstamp: type: string example: example_value state: type: string example: example_value concurrencyMode: type: string example: example_value contentType: type: string example: example_value apiVersion: type: integer contentEncoding: int32 example: 10 examples: - id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: Aborted concurrencyMode: Parallel contentType: CSV apiVersion: 58 ResultPage: title: ResultPage required: - resultLink type: object properties: resultLink: type: string example: example_value examples: - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N SuccessfulGetJobInfoQuery: title: SuccessfulGetJobInfoQuery required: - id - operation - object - createdById - createdDate - systemModstamp - state - concurrencyMode - contentType - apiVersion - jobType - retries - totalProcessingTime - apiActiveProcessingTime - apexProcessingTime type: object properties: id: type: string example: abc123 operation: type: string example: example_value object: type: string example: example_value createdById: type: string example: '500123' createdDate: type: string example: example_value systemModstamp: type: string example: example_value state: type: string example: example_value concurrencyMode: type: string example: example_value contentType: type: string example: example_value apiVersion: type: integer contentEncoding: int32 example: 10 jobType: type: string example: example_value retries: type: integer contentEncoding: int32 example: 10 totalProcessingTime: type: integer contentEncoding: int32 example: 1700000000000 apiActiveProcessingTime: type: integer contentEncoding: int32 example: 1700000000000 apexProcessingTime: type: integer contentEncoding: int32 example: 1700000000000 examples: - id: 750... operation: insert object: Account createdById: 005... createdDate: systemModstamp: state: Open concurrencyMode: Parallel contentType: CSV apiVersion: 58 jobType: Classic retries: 0 totalProcessingTime: 0 apiActiveProcessingTime: 0 apexProcessingTime: 0 GetParallelResultsforaQueryJob: title: GetParallelResultsforaQueryJob required: - resultPages - nextRecordsUrl - done type: object properties: resultPages: type: array items: $ref: '#/components/schemas/ResultPage' description: '' example: [] nextRecordsUrl: type: string example: https://www.example.com done: type: boolean example: true examples: - resultPages: - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N done: false AbortaJobQueryRequest: title: AbortaJobQueryRequest required: - state type: object properties: state: type: string example: example_value examples: - state: Aborted SuccessfulCreatejobQueryRequest: title: SuccessfulCreatejobQueryRequest required: - operation - query - contentType - columnDelimiter - lineEnding type: object properties: operation: type: string example: example_value query: type: string example: example_value contentType: type: string example: example_value columnDelimiter: type: string example: example_value lineEnding: type: string example: example_value examples: - operation: query query: SELECT fields FROM object WHERE filter contentType: CSV columnDelimiter: BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB lineEnding: CRLF | LF SuccessfulCreatejobQuery: title: SuccessfulCreatejobQuery required: - id - operation - object - createdById - createdDate - systemModstamp - state - concurrencyMode - contentType - apiVersion - lineEnding - columnDelimiter type: object properties: id: type: string example: abc123 operation: type: string example: example_value object: type: string example: example_value createdById: type: string example: '500123' createdDate: type: string example: example_value systemModstamp: type: string example: example_value state: type: string example: example_value concurrencyMode: type: string example: example_value contentType: type: string example: example_value apiVersion: type: integer contentEncoding: int32 example: 10 lineEnding: type: string example: example_value columnDelimiter: type: string example: example_value examples: - id: 750... operation: query object: Account createdById: 005... createdDate: systemModstamp: state: UploadComplete concurrencyMode: Parallel contentType: CSV apiVersion: 58 lineEnding: LF columnDelimiter: COMMA 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}". '