Integration Procedure Service Run Options

Input representation of the optional parameters to customize and refine the execution of the integration procedure.

JSON Example 

1{
2  "options": {
3    "ignoreCache": false,
4    "resetCache": true
5  }
6}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
chainableBooleanIndicates whether the integration procedure is executed in multiple chained calls (true) or as a single call (false).
If the chainable property is set to true, the integration procedure automatically splits into smaller, sequentially executed pieces to avoid exceeding Salesforce governor limits or configured timeout thresholds.
The default value is false.
Optional64.0
ignoreCacheBooleanIndicates whether to ignore the cache during the execution of the integration procedure (true) or not (false).
The default value is false.
Optional64.0
isDebugBooleanIndicates whether to display the debugging details in the response (true) or not (false).
The default value is false.
Optional64.0
queueable​ChainableBooleanIndicates whether the integration procedure executes the multiple chained calls asynchronously in the background as a queueable job (true) or not (false).
The default value is false.
Optional64.0
resetCacheBooleanIndicates whether to reset the cache during the execution of the integration procedure (true) or not (false).
If set to true, data will be fetched from the database instead of the cache.
The default value is false.
Optional64.0
shouldSend​LegacyResponseBooleanIndicates whether response is displayed in the legacy Apex object format (true) or not (false).
The default value is false.
Optional64.0
useFutureBooleanIndicates whether the integration procedure should run asynchronously as a fire-and-forget Apex job without returning a response (true) or not (false).
The default value is false.
Optional64.0
useQueueableBooleanIndicates whether the integration procedure should run asynchronously by using a queueable Apex job that returns a job ID in the response (true) or not (false).
The default value is false.
Optional64.0
useQueueable​ApexRemotingBooleanIndicates whether to run the operation in a queueable Apex job with no chaining (true) or not (false).
The default value is false.
Optional64.0
vlcApex​ResponseBooleanIndicates whether the response payload must be displayed (true) or not (false).
If set to true, the response payload is displayed that contains the fields, such as vlcStatus, vlcIPData, and vlcMessage to manage and track the execution state of a chainable process.
The default value is false.
Optional64.0
vlcIPDataStringUnique key that represents the saved execution state of a chainable integration procedure.
This key is included in the subsequent calls to resume processing from where the execution of the integration procedure left off.
Optional64.0
vlcMessageStringContains error messages or additional information that’s returned by the integration procedure.
The value is null if there are no messages returned by the integration procedure.
Optional64.0
vlcStatusStringCurrent status of the execution process of the integration procedure.Optional64.0