Create Integration Plan

Creates an integration plan record based on an object by using Expression Sets to make decisions and Dynamic Fulfillment Orchestration to create related object records.

This action is available in API version 60.0 and later for users with a Financial Services Cloud license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/createIntegrationPlan

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input Type Description
contextDefinitionName string Required. Name of the Context Definition record to build the context data for. Available in API version 61.0 and later.
contextMappingName string Required. Name of the Context Mapping record used to build the context. Available in API version 61.0 and later.
isTaggedData boolean Indicates if the key in the data is a tagged key (true) or not (false). The default value is false. Available in API version 61.0 and later.
contextData string JSON data of the context data record. Available in API version 61.0 and later.
expressionSetName string API name of the expression set that identifies eligible integrations and their dependencies.
anchorRecordId ID ID of the record that supplies any expression set input parameters missing from contextId.

Outputs

Output Type Description
integrationPlanId ID of the integration plan, which includes each callout step and step dependency.

Example

This example shows a sample input for the Create Integration Plan action.
1{
2  "inputs": [
3    {
4      "contextDefinitionName": "Home Loan Application Context",
5      "contextMappingName": "Home Loan Application Context Mapping",
6      "isTaggedData": false,
7      "contextData": {"{\"businessObjectType\": \"Application Form\",\"id\":\"13XSM0000000TjZxxU\"}"},
8      "expressionSetName": "HomeLoanIntegrationsES",
9      "anchorRecordId": "13XSM0000000TjZxxU"
10    }
11  ]
12}
This example shows a sample output for the Create Integration Plan action.
1{
2  "actionName": "createIntegrationPlan",
3  "errors": null,
4  "isSuccess": true,
5  "outputValues": {
6    "integrationPlanId": "13VSB000000IsYD2A0"
7  },
8  "version": 1
9}