Loading
Salesforce now sends email only from verified domains. Read More
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Configuring an Apex REST Data Source (Managed Package)

            You are here:

            1. Salesforce Help
            2. Docs
            3. Omnistudio for Managed Packages

            Configuring an Apex REST Data Source (Managed Package)

            For the managed package runtime, configure a data source to use an Apex REST call to fetch data to populate fields on a Flexcard.

            See

            Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

            Introduction to Apex REST.

            Note
            Note

            For optimal flexibility and easier implementation, use an Integration Procedure as a data source to execute multiple actions in a single server call. See Configuring an Integration Procedure Data Source (Managed Package).

            To configure Salesforce to use an Apex REST method:

            1. On the Vlocity Cards tab, click New to configure a data source for a new cards component, or select an existing component to configure its data source.
            2. In the Cards Designer, in the Layout or Cards pane, from the Data Source picklist, select Apex REST.
            3. In the Endpoint field, enter the URL of the REST endpoint.
            4. Specify the REST method:

              • GET—Requests data specified by the parameters of the URL.

              • POST—Sends JSON data specified in the Body text area.

                image

              You can use Context Variables to pass inherited values with either method.

            5. (Optional). Enter values for these properties:

              • To drill down to a specific dataset, in the Result JSON Path field, enter a path. For example, enter records.results, which drills down to the results array and passes the array to the card or card layout.

              • To sort data by a specific data field, enter the field name in the Order By input field.

              • To reverse the order of the data returned, select True from the Reverse Order picklist.

                image

              • Set a Timeout value in milliseconds.

                The timeout value controls the time that the framework waits for the designated data source to return a response. Timeouts improve handling user interactions with long running processes. Setting an appropriate timeout value allows the application and users to react accordingly to long wait times.

              • Set an Interval value in milliseconds.

                The card component's data source refreshes continuously at the given interval and checks for changes in data source records. If changes are found, the layout or card component reloads. Setting an interval enables recursive updates of records.

            6. To preview a card using real data, add a test variable in the Test Data Source Settings fields. See Testing Data Source Settings (Managed Package).
             
            Loading
            Salesforce Help | Article