openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Table 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: Table
paths:
/data/v64.0/connect/business-rules/decision-matrices/{matrixUniqueName}:
parameters: []
post:
tags:
- Table
summary: Salesforce Lookup Table
description: "# Decision Matrix (Lookup Table)\n\nPerforms a lookup on decision matrix rows based on the input values provided, and returns the row’s output.Resource\n\n```\n/connect/business-rules/decision-matrices/${matrixName}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/vXX.X/connect\n/business-rules/decision-matrices/InsurancePremium\n\n ```\n\nAvailable version\n\n55.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n \"inputs\": [\n {\n \"input\": [\n {\n \"name\": \"premium\",\n \"value\": \"2400\"\n }\n ]\n }\n ],\n \"options\": {\n \"effectiveDate\": \"2022-12-03T10:15:30Z\"\n }\n}\n\n ```\n\nHere, premium is a column header in the matrix, and 2400 is a value of a cell in the column.Properties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| inputs | [Decision Matrix Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_input.htm) | List of inputs passed to a decision matrix. An input may contain multiple variables. | Required | 55.0 |\n| options | [Decision Matrix Options Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_options.htm) | The lookup options for a decision matrix. | Optional | 55.0 |\n\nResponse body for POST\n\n[Decision Matrix Lookup Result](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_bre_decision_matrix_lookup_result.htm)"
operationId: LookupTable
parameters:
- name: matrixUniqueName
in: path
description: The value of Unique Name is the unique identifier of the record, which is sourced from the name of a decision matrix.
required: true
schema:
type: string
examples:
- myDecisionMatrix
example: example_value
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LookupTableRequest'
- examples:
- inputs:
- input:
- name: myColumnInput
value: One
options: {}
contentMediaType: application/json
example:
inputs:
- input:
- name: myColumnInput
value: One
options: {}
required: true
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 07 Sep 2023 12:12: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
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/Status201-AcceptedButWarning'
- examples:
- outputs:
- error: Looks like there isn’t any output for the specified input parameters in the lookup table.
results: []
contentMediaType: application/json;charset=UTF-8
example:
outputs:
- error: Looks like there isn’t any output for the specified input parameters in the lookup table.
results: []
'400':
description: Bad Request
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 07 Sep 2023 11:50:19 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-MatrixNotFound1'
description: ''
examples:
- - errorCode: INVALID_INPUT
message: Specify a valid matrixName and try again.
contentMediaType: application/json;charset=UTF-8
example:
- errorCode: INVALID_INPUT
message: Specify a valid matrixName and try again.
'401':
description: Unauthorized
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 07 Sep 2023 11:49:04 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
WWW-Authenticate:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Token
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/Status401-Unauthorized1'
description: ''
examples:
- - message: Session expired or invalid
errorCode: INVALID_SESSION_ID
contentMediaType: application/json;charset=UTF-8
example:
- message: Session expired or invalid
errorCode: INVALID_SESSION_ID
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/decision-table/definitions:
parameters: []
post:
tags:
- Table
summary: Salesforce Create Table
description: "# Decision Table Definitions (POST)\n\nCreate a decision table definition. A decision table definition contains all the details required to create a decision table.Resource\n\n```\n/connect/business-rules/decision-table/definitions\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nJSON example for a single object source\n\n```\n{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"usageType\":\"ProductEligibility\",\n \"sourceType\":\"SingleSobject\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}\n\n ```\n\nJSON example for a multi-object source\n\n```\n{\n \"setupName\":\"Jumbo Pricing Definition\",\n \"fullName\":\"JumboPricingDefinition\",\n \"description\":\"Join all the DT definitions into one jumbo pricing definition\",\n \"usageType\":\"ProductEligibility\",\n \"type\":\"LowVolume\",\n \"sourceType\":\"MultipleSobjects\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3 OR 4 OR 5\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\",\n \"columnMapping\":\"IsDeleted\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\",\n \"columnMapping\":\"Id\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\",\n \"columnMapping\":\"Title\"\n },\n {\n \"fieldName\":\"OldvalNumber\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"4\",\n \"columnMapping\":\"AccountHistory.OldvalNumber\"\n },\n {\n \"fieldName\":\"OldvalString\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"5\",\n \"columnMapping\":\"AccountHistory.OldvalString\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"CreatedById\"\n },\n {\n \"fieldName\":\"NewvalNumber\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"AccountHistory.NewvalNumber\"\n },\n {\n \"fieldName\":\"NewvalString\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"AccountHistory.NewvalString\"\n }\n ]\n \"sourceCriteria\":[\n {\n \"sourceFieldName\":\"OldvalString\",\n \"value\":\"5\",\n \"operator\":\"Equals\",\n \"valueType\":\"Parameter\",\n \"sequenceNumber\":\"1\"\n }\n ]\n}\n\n ```\n\nRequest body for POSTProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| collectOperator | String | Operator to apply a filter to outputs. Possible values are:
\\- Count
\\- Maximum
\\- Minimum
\\- None
\\- Sum | Optional | 58.0 |\n| conditionCriteria | String | Custom logic applied on the decision table columns to decide how the input fields are processed. | Optional
Required when the condition type is Custom. | 58.0 |\n| conditionType | String | Condition logic for input fields. Possible values are:
\\- All
\\- Any
\\- Custom | Optional | 58.0 |\n| description | String | Description of the decision table. | Optional | 58.0 |\n| decisionResultPolicy | String | Results policy to filter results of the decision table. Possible values are:
\\- AnyValue
\\- CollectOperator
\\- FirstMatch
\\- OutputOrder
\\- Priority
\\- RuleOrder
\\- UniqueValues | Optional | |\n| fullName | String | Unique name of the rule definition. | Required | 58.0 |\n| isSetCollectOperator | Boolean | For internal use only.
Indicates whether the collectOperator is enabled (true) or not (false). | Optional | 58.0 |\n| isSetConditionCriteria | Boolean | For internal use only.
Indicates whether the conditionCriteria field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetConditionType | Boolean | For internal use only.
Indicates whether the conditionType field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetDescription | Boolean | For internal use only.
Indicates whether the description field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetDecisionResultPolicy | Boolean | For internal use only.
Indicates whether the DecisionResultPolicy field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetFullName | Boolean | For internal use only.
Indicates whether the FullName field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetParameters | Boolean | For internal use only. Indicates whether the parameters field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSetupName | Boolean | For internal use only.
Indicates whether the setupName field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceconditionLogic | Boolean | For internal use only.
Indicates whether the sourceConditionLogic field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceCriteria | Boolean | For internal use only.
Indicates whether the sourceCriteria field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceObject | Boolean | For internal use only.
Indicates whether the sourceObject field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceType | Boolean | For internal use only.
Indicates whether the sourceType is enabled (true) or not (false). | Optional | 58.0 |\n| isSetType | Boolean | For internal use only.
Indicates whether the type field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetUsageType | Boolean | For internal use only.
Indicates whether the UsageType field is enabled (true) or not (false). | Optional | 58.0 |\n| parameters | [Decision Table Parameter Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_parameter_input.htm)\\[\\] | Array of input and output fields for the decision table. | Optional | 58.0 |\n| setupName | String | Name of the decision table. | Required | 58.0 |\n| sourceconditionLogic | String | Custom logic to filter the decision table rows. | Optional | 58.0 |\n| sourceCriteria | [Decision Table Source Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_source_criteria_input.htm)\\[\\] | Output array representation of source filters for the decision table rows, such as, fieldName, operators, valueType, and more. | Optional | 58.0 |\n| sourceObject | String | Object containing business rules for the decision table to read. | Required | 58.0 |\n| sourceType | String | Type of source to obtain decision table data. Possible values are:
\\- CsvUpload
\\- MultipleSobjects
\\- SingleSobject | Required | 58.0 |\n| status | String | Status of the decision table. Possible values are:
\\- ActivationInProgress
\\- ActivationInProgress
\\- Draft
\\- Inactive | Required | 58.0 |\n| type | String | Type of the decision table. Possible values are:
\\- HighVolume
\\- LowVolume | Optional | 58.0 |\n| usageType | String | Process type that uses the decision table. Possible values are:
\\- Pricing
\\- ProductEligibility | Optional | 58.0 |\n\nResponse body for POST\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |"
operationId: CreateTable
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CreateTableRequest'
- examples:
- setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
sourceObject: AccountFeed
status: Draft
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
contentMediaType: application/json
example:
setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
sourceObject: AccountFeed
status: Draft
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
required: true
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 12:41: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
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/Status201-Success4'
- examples:
- code: '200'
decisionTable:
id: 0lDHo0000008Pnt
parameters: []
sourceCriteria: []
isSuccess: true
message: ''
contentMediaType: application/json;charset=UTF-8
example:
code: '200'
decisionTable:
id: 0lDHo0000008Pnt
parameters: []
sourceCriteria: []
isSuccess: true
message: ''
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/decision-table/definitions/{decisionTableId}:
parameters: []
get:
tags:
- Table
summary: Salesforce Get Table
description: "# Decision Table Definitions ( GET)\n\nGet details of a decision table definition.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\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[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |"
operationId: GetTable
parameters:
- name: decisionTableId
in: path
description: Decision Table Id
required: true
schema:
type: string
examples:
- 0lDHo0000008Po3
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 13:05: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
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-Success'
- examples:
- code: '200'
decisionTable:
conditionCriteria: 1 OR 2 OR 3
conditionType: Any
description: Eligiblity of Products using Qualification Rules
id: 0lDHo0000008Pnt
parameters:
- fieldName: IsDeleted
isGroupByField: false
operator: Equals
sequence: 1
usage: Input
- fieldName: CreatedById
isGroupByField: false
usage: Output
- fieldName: Title
isGroupByField: false
operator: Equals
sequence: 3
usage: Input
- fieldName: Id
isGroupByField: false
operator: Equals
sequence: 2
usage: Input
setupName: Product Qualificiation eligibility
sourceCriteria: []
sourceObject: AccountFeed
status: Active
isSuccess: true
message: ''
contentMediaType: application/json;charset=UTF-8
example:
code: '200'
decisionTable:
conditionCriteria: 1 OR 2 OR 3
conditionType: Any
description: Eligiblity of Products using Qualification Rules
id: 0lDHo0000008Pnt
parameters:
- fieldName: IsDeleted
isGroupByField: false
operator: Equals
sequence: 1
usage: Input
- fieldName: CreatedById
isGroupByField: false
usage: Output
- fieldName: Title
isGroupByField: false
operator: Equals
sequence: 3
usage: Input
- fieldName: Id
isGroupByField: false
operator: Equals
sequence: 2
usage: Input
setupName: Product Qualificiation eligibility
sourceCriteria: []
sourceObject: AccountFeed
status: Active
isSuccess: true
message: ''
'400':
description: Bad Request
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 13:20:33 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-InstanceNotFound1'
description: ''
examples:
- - errorCode: INVALID_ID_FIELD
message: We couldn’t find a record with that ID. Specify a valid decisionTableId and try again.
contentMediaType: application/json;charset=UTF-8
example:
- errorCode: INVALID_ID_FIELD
message: We couldn’t find a record with that ID. Specify a valid decisionTableId and try again.
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Table
summary: Salesforce Delete Table
description: "# Decision Table Definitions ( DELETE)\n\nDelete a decision table definition associated with a decision table.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE\n\nResponse body for DELETE\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |"
operationId: DeleteTable
parameters:
- name: decisionTableId
in: path
description: Decision Table Id
required: true
schema:
type: string
examples:
- 0lDHo0000008Pny
example: '500123'
responses:
'204':
description: No Content
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 13:36:22 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
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
patch:
tags:
- Table
summary: Salesforce Update Table
description: "# Decision Table Definitions ( DELETE)\n\nDelete a decision table definition associated with a decision table.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE\n\nResponse body for DELETE\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |"
operationId: UpdateTable
parameters:
- name: decisionTableId
in: path
description: Decision Table Id
required: true
schema:
type: string
examples:
- 0lDHo0000008Po3
example: '500123'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateTableRequest'
- examples:
- setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
usageType: ProductEligibility
sourceType: SingleSobject
sourceObject: AccountFeed
status: Draft
decisionResultPolicy: UniqueValues
collectOperator: Count
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
contentMediaType: application/json
example:
setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
usageType: ProductEligibility
sourceType: SingleSobject
sourceObject: AccountFeed
status: Draft
decisionResultPolicy: UniqueValues
collectOperator: Count
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 14:02:00 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:
allOf:
- $ref: '#/components/schemas/Status200-Success2'
- examples:
- code: '200'
isSuccess: true
message: ''
contentMediaType: application/json;charset=UTF-8
example:
code: '200'
isSuccess: true
message: ''
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/decision-table/{decisionTableId}:
parameters: []
post:
tags:
- Table
summary: Salesforce Lookup Table
description: "# Decision Table (Lookup Table)\n\nPerforms a lookup on a decision table.Resource\n\n```\n/connect/business-rules/decision-table/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v55.0/connect\n/decision-table/0lDB0000000TNQzMAO\n\n ```\n\nAvailable version\n\n55.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n \"conditions\" : {\n \"conditionsList\" : [\n {\n \"fieldName\": \"state__c\",\n \"value\": \"MH\"\n },\n {\n \"fieldName\": \"validity__c\",\n \"value\": 30\n }\n ]\n }\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| conditions | [Decision Table Condition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_condition.htm)\\[\\] | The list of decision table conditions on which the decision table executes and provides outcomes. | Required | 55.0 |\n| datasetLinkName | String | The API name of the dataset link provided as an input for the decision table execution. | Optional | 55.0 |\n\nResponse body for POST\n\n[Decision Table Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome.htm)\n\n# Decision Table Outcome\n\nOutput representation of the decision table execution.JSON example\n\n```\n{\n \"errorCode\" : null,\n \"errorMessage\" : null,\n \"outcomeList\" : [ {\n \"values\" : {\n \"amount__c\" : \"399\",\n \"Name\" : \"MH 005\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"499\",\n \"Name\" : \"MH 006\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"379\",\n \"Name\" : \"MH 007\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"1498\",\n \"Name\" : \"MH 008\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"98\",\n \"Name\" : \"MH 009\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"251\",\n \"Name\" : \"MH 010\"\n }\n } ],\n \"outcomeType\" : \"Multiple Matches\",\n \"successStatus\" : true\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| errorCode | Integer | The error code if transaction fails for any reason. | Small, 55.0 | 55.0 |\n| errorMessage | String | The error message if transaction fails for any reason. | Small, 55.0 | 55.0 |\n| outcomeList | [Decision Table Outcome Item](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome_item.htm)\\[\\] | Outcome list that stores two or more outcomes provided by the decision table. | Small, 55.0 | 55.0 |\n| outcomeType | String | The outcome type after the request is successful. | Small, 55.0 | 55.0 |\n| successStatus | Boolean | Indicates the status of the decision table execution. | Small, 55.0 | 55.0 |"
operationId: PostLookupTable
parameters:
- name: decisionTableId
in: path
description: Decision Table Id
required: true
schema:
type: string
examples:
- 0lDHo0000008Pnt
example: '500123'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LookupTableRequest1'
- examples:
- conditions:
conditionsList:
- fieldName: IsDeleted
value: true
contentMediaType: application/json
example:
conditions:
conditionsList:
- fieldName: IsDeleted
value: true
required: true
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 13:22: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
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/Status201-Success5'
- examples:
- errorCode: null
errorMessage: null
outcomeList: []
outcomeType: No Match
successStatus: true
contentMediaType: application/json;charset=UTF-8
example:
errorCode: null
errorMessage: null
outcomeList: []
outcomeType: No Match
successStatus: true
'400':
description: Bad Request
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 12:16:33 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: 0lIHo000000LFC6MAO'
contentMediaType: application/json;charset=UTF-8
example:
- errorCode: INVALID_ID_FIELD
message: 'Invalid identifier: 0lIHo000000LFC6MAO'
'500':
description: Server Error
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Tue, 19 Sep 2023 12:31:01 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-UnknownException1'
description: ''
examples:
- - message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1716762391-743375 (1633993601)'
errorCode: UNKNOWN_EXCEPTION
contentMediaType: application/json;charset=UTF-8
example:
- message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1716762391-743375 (1633993601)'
errorCode: UNKNOWN_EXCEPTION
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
Input2:
title: Input2
required:
- name
- value
type: object
properties:
name:
type: string
example: Example Title
value:
type: string
example: example_value
examples:
- name: myColumnInput
value: One
Output1:
title: Output1
required:
- error
- results
type: object
properties:
error:
type: string
example: example_value
results:
type: array
items:
type: string
description: ''
example: []
examples:
- error: Looks like there isn’t any output for the specified input parameters in the lookup table.
results: []
Status200-Success:
title: Status200-Success
required:
- code
- decisionTable
- isSuccess
- message
type: object
properties:
code:
type: string
example: example_value
decisionTable:
$ref: '#/components/schemas/DecisionTable1'
isSuccess:
type: boolean
example: true
message:
type: string
example: example_value
examples:
- code: '200'
decisionTable:
conditionCriteria: 1 OR 2 OR 3
conditionType: Any
description: Eligiblity of Products using Qualification Rules
id: 0lDHo0000008Pnt
parameters:
- fieldName: IsDeleted
isGroupByField: false
operator: Equals
sequence: 1
usage: Input
- fieldName: CreatedById
isGroupByField: false
usage: Output
- fieldName: Title
isGroupByField: false
operator: Equals
sequence: 3
usage: Input
- fieldName: Id
isGroupByField: false
operator: Equals
sequence: 2
usage: Input
setupName: Product Qualificiation eligibility
sourceCriteria: []
sourceObject: AccountFeed
status: Active
isSuccess: true
message: ''
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'
Status400-MatrixNotFound1:
title: Status400-MatrixNotFound1
required:
- errorCode
- message
type: object
properties:
errorCode:
type: string
example: example_value
message:
type: string
example: example_value
examples:
- errorCode: INVALID_INPUT
message: Specify a valid matrixName and try again.
Status201-AcceptedButWarning:
title: Status201-AcceptedButWarning
required:
- outputs
type: object
properties:
outputs:
type: array
items:
$ref: '#/components/schemas/Output1'
description: ''
example: []
examples:
- outputs:
- error: Looks like there isn’t any output for the specified input parameters in the lookup table.
results: []
LookupTableRequest1:
title: LookupTableRequest1
required:
- conditions
type: object
properties:
conditions:
$ref: '#/components/schemas/Conditions'
examples:
- conditions:
conditionsList:
- fieldName: IsDeleted
value: true
DecisionTable1:
title: DecisionTable1
required:
- conditionCriteria
- conditionType
- description
- id
- parameters
- setupName
- sourceCriteria
- sourceObject
- status
type: object
properties:
conditionCriteria:
type: string
example: example_value
conditionType:
type: string
example: example_value
description:
type: string
example: A sample description.
id:
type: string
example: abc123
parameters:
type: array
items:
$ref: '#/components/schemas/Parameter1'
description: ''
example: []
setupName:
type: string
example: example_value
sourceCriteria:
type: array
items:
type: string
description: ''
example: []
sourceObject:
type: string
example: example_value
status:
type: string
example: example_value
examples:
- conditionCriteria: 1 OR 2 OR 3
conditionType: Any
description: Eligiblity of Products using Qualification Rules
id: 0lDHo0000008Pnt
parameters:
- fieldName: IsDeleted
isGroupByField: false
operator: Equals
sequence: 1
usage: Input
- fieldName: CreatedById
isGroupByField: false
usage: Output
- fieldName: Title
isGroupByField: false
operator: Equals
sequence: 3
usage: Input
- fieldName: Id
isGroupByField: false
operator: Equals
sequence: 2
usage: Input
setupName: Product Qualificiation eligibility
sourceCriteria: []
sourceObject: AccountFeed
status: Active
Status201-Success4:
title: Status201-Success4
required:
- code
- decisionTable
- isSuccess
- message
type: object
properties:
code:
type: string
example: example_value
decisionTable:
$ref: '#/components/schemas/DecisionTable'
isSuccess:
type: boolean
example: true
message:
type: string
example: example_value
examples:
- code: '200'
decisionTable:
id: 0lDHo0000008Pnt
parameters: []
sourceCriteria: []
isSuccess: true
message: ''
Status400-InstanceNotFound1:
title: Status400-InstanceNotFound1
required:
- errorCode
- message
type: object
properties:
errorCode:
type: string
example: example_value
message:
type: string
example: example_value
examples:
- errorCode: INVALID_ID_FIELD
message: We couldn’t find a record with that ID. Specify a valid decisionTableId and try again.
Parameter:
title: Parameter
required:
- fieldName
- usage
type: object
properties:
fieldName:
type: string
example: example_value
usage:
type: string
example: example_value
operator:
type: string
example: example_value
sequence:
type: string
example: example_value
examples:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
Status500-UnknownException1:
title: Status500-UnknownException1
required:
- message
- errorCode
type: object
properties:
message:
type: string
example: example_value
errorCode:
type: string
example: example_value
examples:
- message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1716762391-743375 (1633993601)'
errorCode: UNKNOWN_EXCEPTION
CreateTableRequest:
title: CreateTableRequest
required:
- setupName
- fullName
- description
- sourceObject
- status
- conditionType
- conditionCriteria
- parameters
type: object
properties:
setupName:
type: string
example: example_value
fullName:
type: string
example: example_value
description:
type: string
example: A sample description.
sourceObject:
type: string
example: example_value
status:
type: string
example: example_value
conditionType:
type: string
example: example_value
conditionCriteria:
type: string
example: example_value
parameters:
type: array
items:
$ref: '#/components/schemas/Parameter'
description: ''
example: []
examples:
- setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
sourceObject: AccountFeed
status: Draft
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
LookupTableRequest:
title: LookupTableRequest
required:
- inputs
- options
type: object
properties:
inputs:
type: array
items:
$ref: '#/components/schemas/Input1'
description: ''
example: []
options:
type: object
example: example_value
examples:
- inputs:
- input:
- name: myColumnInput
value: One
options: {}
Status200-Success2:
title: Status200-Success2
required:
- code
- isSuccess
- message
type: object
properties:
code:
type: string
example: example_value
isSuccess:
type: boolean
example: true
message:
type: string
example: example_value
examples:
- code: '200'
isSuccess: true
message: ''
Status201-Success5:
title: Status201-Success5
required:
- errorCode
- errorMessage
- outcomeList
- outcomeType
- successStatus
type: object
properties:
errorCode:
type:
- string
- 'null'
example: example_value
errorMessage:
type:
- string
- 'null'
example: example_value
outcomeList:
type: array
items:
type: string
description: ''
example: []
outcomeType:
type: string
example: example_value
successStatus:
type: boolean
example: true
examples:
- errorCode: null
errorMessage: null
outcomeList: []
outcomeType: No Match
successStatus: true
Input1:
title: Input1
required:
- input
type: object
properties:
input:
type: array
items:
$ref: '#/components/schemas/Input2'
description: ''
example: []
examples:
- input:
- name: myColumnInput
value: One
Status401-Unauthorized1:
title: Status401-Unauthorized1
required:
- message
- errorCode
type: object
properties:
message:
type: string
example: example_value
errorCode:
type: string
example: example_value
examples:
- message: Session expired or invalid
errorCode: INVALID_SESSION_ID
Parameter1:
title: Parameter1
required:
- fieldName
- isGroupByField
- usage
type: object
properties:
fieldName:
type: string
example: example_value
isGroupByField:
type: boolean
example: true
operator:
type: string
example: example_value
sequence:
type: integer
contentEncoding: int32
example: 10
usage:
type: string
example: example_value
examples:
- fieldName: IsDeleted
isGroupByField: false
operator: Equals
sequence: 1
usage: Input
UpdateTableRequest:
title: UpdateTableRequest
required:
- setupName
- fullName
- description
- usageType
- sourceType
- sourceObject
- status
- decisionResultPolicy
- collectOperator
- conditionType
- conditionCriteria
- parameters
type: object
properties:
setupName:
type: string
example: example_value
fullName:
type: string
example: example_value
description:
type: string
example: A sample description.
usageType:
type: string
example: example_value
sourceType:
type: string
example: example_value
sourceObject:
type: string
example: example_value
status:
type: string
example: example_value
decisionResultPolicy:
type: string
example: example_value
collectOperator:
type: string
example: example_value
conditionType:
type: string
example: example_value
conditionCriteria:
type: string
example: example_value
parameters:
type: array
items:
$ref: '#/components/schemas/Parameter'
description: ''
example: []
examples:
- setupName: Product Qualificiation eligibility
fullName: ProductQualificationEligibility
description: Eligiblity of Products using Qualification Rules
usageType: ProductEligibility
sourceType: SingleSobject
sourceObject: AccountFeed
status: Draft
decisionResultPolicy: UniqueValues
collectOperator: Count
conditionType: Any
conditionCriteria: 1 OR 2 OR 3
parameters:
- fieldName: IsDeleted
usage: INPUT
operator: Equals
sequence: '1'
- fieldName: Id
usage: INPUT
operator: Equals
sequence: '2'
- fieldName: Title
usage: INPUT
operator: Equals
sequence: '3'
- fieldName: CreatedById
usage: OUTPUT
DecisionTable:
title: DecisionTable
required:
- id
- parameters
- sourceCriteria
type: object
properties:
id:
type: string
example: abc123
parameters:
type: array
items:
type: string
description: ''
example: []
sourceCriteria:
type: array
items:
type: string
description: ''
example: []
examples:
- id: 0lDHo0000008Pnt
parameters: []
sourceCriteria: []
ConditionsList1:
title: ConditionsList1
required:
- fieldName
- value
type: object
properties:
fieldName:
type: string
example: example_value
value:
type: boolean
example: true
examples:
- fieldName: IsDeleted
value: true
Conditions:
title: Conditions
required:
- conditionsList
type: object
properties:
conditionsList:
type: array
items:
$ref: '#/components/schemas/ConditionsList1'
description: ''
example: []
examples:
- conditionsList:
- fieldName: IsDeleted
value: true
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}".
'