Run Integration Plan

Triggers an integration plan using Dynamic Fulfillment Orchestration, which ensures each callout happens at the right time by queuing it alongside its dependent steps.

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/runIntegrationPlan

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
contextId	ID	ID of the Context Service which references the record ID that supplies expression set input parameters. Recommended record objects are Applicant, ApplicationForm, and PartyProfile.
integrationPlanId		ID of the integration plan, which includes each callout step and step dependency.

Outputs

Output	Type	Description
status		Status of the integration plan’s progress. Valid values are Running, Not Started, Failed.

Example

JSON Request Body

{
  "inputs": {
    "integrationPlanId" : "13VSB000000IsYD2A0"
  }
}

JSON Response Body

{
  "actionName": "runIntegrationPlan",
  "errors": null,
  "isSuccess": true,
  "outputValues": {
    "status": "SUCCESS"
  },
  "version": 1
}