Omniscript

Get the discovery framework structure stored as OmniProcess.

Use this API to get the assessment form layout and submit the assessment data through any custom-built UI. You can show the questionnaire form, capture assessment responses, and save the assessment.

Resource 

1/connect/omniscript/{omniScriptId}

The omniScriptId property is the ID of the Omniscript to get the discovery framework structure stored as an OmniProcess.

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v60.0/connect/omniscript/CREDIT_CARD_DISPUTE_TRANSACTION_ENGLISH_1?customType=DiscoveryFramework

{yourInstance} is the domain name of your Salesforce instance.

Available Version 

60.0

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
customTypeStringCustom type of Omniscript. For example, Discovery Framework.Required60.0

Response Body for GET 

Omniscript Output