openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Retrieves 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: Retrieves
paths:
/async/64.0/job//batch/{_batchId}/result:
parameters: []
get:
tags:
- Retrieves
summary: Salesforce Bulk Retrieve Batch Result
operationId: BulkRetrieveBatchResult
parameters:
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Accept-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: Content-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: _batchId
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: Thu, 16 Nov 2023 16:20:11 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
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:
text/csv:
schema:
type: string
examples:
- '"Id","Success","Created","Error"
"001...","true","true",""
'
contentMediaType: text/csv
example: '"Id","Success","Created","Error"
"001...","true","true",""
'
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/async/64.0/job//batch/{_batchId}/result/{batchResultId}:
parameters: []
get:
tags:
- Retrieves
summary: Salesforce Bulk Retrieve Batch Result Data
operationId: BulkRetrieveBatchResultData
parameters:
- name: batchResultId
in: path
description: ''
required: true
schema:
type: string
examples:
- 'null'
example: '500123'
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Accept-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: Content-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: _batchId
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: Thu, 16 Nov 2023 16:36:36 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
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:
text/csv; charset=UTF-8:
schema:
type: string
examples:
- '"Id","Name"
"001...","GenePoint"
"001...","United Oil & Gas, UK"
"001...","United Oil & Gas, Singapore"
"001...","Edge Communications"
"001...","Burlington Textiles Corp of America"
"001...","Pyramid Construction Inc."
"001...","Dickenson plc"
"001...","Grand Hotels & Resorts Ltd"
"001...","Express Logistics and Transport"
"001...","University of Arizona"
"001...","United Oil & Gas Corp."
"001...","sForce"
"001...","Exemple de comptes pour les autorisations"
"001...","Tom Jones"
'
contentMediaType: text/csv; charset=UTF-8
example: '"Id","Name"
"001...","GenePoint"
"001...","United Oil & Gas, UK"
"001...","United Oil & Gas, Singapore"
"001...","Edge Communications"
"001...","Burlington Textiles Corp of America"
"001...","Pyramid Construction Inc."
"001...","Dickenson plc"
"001...","Grand Hotels & Resorts Ltd"
"001...","Express Logistics and Transport"
"001...","University of Arizona"
"001...","United Oil & Gas Corp."
"001...","sForce"
"001...","Exemple de comptes pour les autorisations"
"001...","Tom Jones"
'
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/composite/sobjects/{SOBJECT_API_NAME}:
parameters: []
get:
tags:
- Retrieves
summary: Salesforce Sobject Collections Retrieve
description: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
operationId: SObjectCollectionsRetrieve
parameters:
- name: ids
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: example_value
- name: fields
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: example_value
- 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: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 15:27:03 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=44/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: array
items:
$ref: '#/components/schemas/SuccessfulSObjectCollectionsRetrieve'
description: ''
examples:
- - attributes:
type: Account
url: /services/data/v58.0/sobjects/Account/001...
Name: Sample Account
Id: 001...
contentMediaType: application/json;charset=UTF-8
example:
- attributes:
type: Account
url: /services/data/v58.0/sobjects/Account/001...
Name: Sample Account
Id: 001...
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/business-rules/expression-set/version/{expressionSetVersionId}/dependencies:
parameters: []
get:
tags:
- Retrieves
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/v64.0/connect/business-rules/expression-set/{expressionSetId}:
parameters: []
get:
tags:
- Retrieves
summary: Salesforce Expression Set Retrieve
description: "# Expression Set Retrieve and Delete (DELETE, GET)\n\nEndpoints to read, and delete expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET\n\nRequest body for GET\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| contextDefinitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usageType | String | Usage type of the expression set. <br> <br>Valid values are: <br> <br>\\- AiAcceleratorSubscriberChurnPrediction—Used for Industries Einstein <br> <br>\\- Bre—Used for Business Rules Engine <br> <br>\\- CustomLoyalty—Used for Loyalty Management <br> <br>\\- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud <br> <br>\\- Qualification—Used for Industries Communications, Media, and Energy (CME) <br> <br>\\- RecordAlert—Used for Financial Services Cloud <br> <br>\\- ShipAndDebit—Used for Manufacturing Cloud <br> <br>\\- TierProcessing—Used for Loyalty Management <br> <br>\\- TransactionJournal—Used for Loyalty Management <br> <br>\\- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for GET[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)"
operationId: ExpressionSetRetrieve
parameters:
- name: expressionSetId
in: path
description: 'Expression Set Id: For Example 9QLHo000000LBjEOAW'
required: true
schema:
type: string
examples:
- 9QLHo000000LBngOAG
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 06 Sep 2023 09:34:42 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/Status200-RecordFound'
- examples:
- apiName: myExpressionSet
contextDefinitions: []
id: 9QLHo000000LBjEOAW
name: myExpressionSet
usageType: Bre
versions:
- apiName: myExpressionSet_V1
description: myExpressionSet V1 Description
enabled: true
id: 9QMHo000000LBjJOAW
name: myExpressionSet V1
rank: 1
showExplExternally: true
startDate: '2023-09-06T09:27:06.000Z'
steps:
- actionType: AssignParameterValues
assignment:
assignedParameter: condition_output__1
expression: 'true'
description: my Description
name: myCalculation
resultIncluded: true
sequenceNumber: 1
shouldExposeConditionDetails: false
shouldExposeExecPathMsgOnly: true
shouldShowExplExternally: false
stepType: BusinessKnowledgeModel
variables:
- collection: false
dataType: Boolean
description: condition_output__1
input: false
name: condition_output__1
output: true
type: Variable
value: 'False'
- collection: false
dataType: Boolean
description: condition_output__2
input: false
name: condition_output__2
output: false
type: Variable
value: 'False'
versionNumber: 1
contentMediaType: application/json;charset=UTF-8
example:
apiName: my
# --- truncated at 32 KB (327 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-retrieves-api-openapi.yml