Financial Services Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Financial Services Cloud Developer Guide
Financial Services Cloud Standard Objects
Financial Services Cloud Custom Objects
Financial Services Cloud Associated Objects
Apex Reference
Financial Services Cloud Business APIs
Financial Services Cloud Metadata API
Financial Services Cloud Standard Invocable Actions
Create Financial Records Actions
Create Integration Plan
Get Assessment Response Summary
Run Integration Plan
Financial Services Cloud Tooling API Objects
Financial Services Cloud Custom Metadata Types
Financial Services Cloud Custom Triggers and Validation Rules
Data Processing Engine and Monitor Workflow Services
API End-of-Life Policy
PDF

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
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
contextDefinitionName
Type
string
Description
Required
Name of the Context Definition record to build the context data for. Available in API version 61.0 and later.
contextMappingName
Type
string
Description
Required
Name of the Context Mapping record used to build the context. Available in API version 61.0 and later.
isTaggedData
Type
boolean
Description
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
Type
string
Description
JSON data of the context data record. Available in API version 61.0 and later.
expressionSetName
Type
string
Description
API name of the expression set that identifies eligible integrations and their dependencies.
anchorRecordId
Type
ID
Description
ID of the record that supplies any expression set input parameters missing from contextId.

Outputs

Input Details
integrationPlanId
Type
ID
Description
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.
{
  "inputs": [
    {
      "contextDefinitionName": "Home Loan Application Context",
      "contextMappingName": "Home Loan Application Context Mapping",
      "isTaggedData": false,
      "contextData": {"{\"businessObjectType\": \"Application Form\",\"id\":\"13XSM0000000TjZxxU\"}"},
      "expressionSetName": "HomeLoanIntegrationsES",
      "anchorRecordId": "13XSM0000000TjZxxU"
    }
  ]
}
This example shows a sample output for the Create Integration Plan action.
{
  "actionName": "createIntegrationPlan",
  "errors": null,
  "isSuccess": true,
  "outputValues": {
    "integrationPlanId": "13VSB000000IsYD2A0"
  },
  "version": 1
}