Omnistudio Metadata API Types

Metadata API enables you to access some types and feature settings that you can customize in the user interface.

  • Flow for Omnistudio

    Represents the metadata associated with a flow. Use a flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.

  • DataMapperDefinition

    Represents a Data Mapper’s header configurations, such as its name and type. Data Mappers transfer and transform data between Salesforce and Omnistudio components. They act as data sources in Flexcards and as actions in Omniscripts.

  • FlexcardDefinition

    Each row represents a Flexcard’s configuration such as its name and author. A Flexcard can display data and launch actions or Omniscripts. This object stores specific information about a Flexcard to render it at runtime.

  • IntegrationProcdDefinition

    Represents an Integration Procedure’s header configurations, including its type and subtype. Integration Procedures bundle server-side data operations for efficiency. They act as data sources in Flexcards and as actions in Omniscripts.

  • OmniDataTransform

    Represents the header configuration of a DataRaptor.

  • OmniExtTrackingDef

    Represents a connection between an OmniTrackingGroup in OmniAnalytics and a third-party Analytics system such as Google Analytics.

  • OmniIntegrationProcedure

    Represents an Omnistudio Integration Procedure for the Discovery Framework. It enables declarative, server-side processing to perform multiple actions in a single server call, supporting sales, service, and other business workflows. For Discovery Framework, the customization type is discoveryframework.

  • OmniInteractionAccessConfig

    Represents configuration settings for access to Omnistudio FlexCard caching and data sources.

  • OmniInteractionConfig

    Represents configuration settings for Omnistudio.

  • OmniScript

    Represents an OmniScript for the Discovery Framework, which guides users through sales, service, and other business processes. For Discovery Framework, the customization type is discoveryframework.

  • OmniscriptDefinition

    Represents the header configuration of an Omniscript. Each row represents an Omniscript’s header configurations, such as its type, subtype, and name. An Omniscript helps build guided digital experiences. This object stores primary information about an Omniscript to render it at runtime.

  • OmniStudioSettings

    Represents the settings that help administrators turn on specific Omnistudio features and capabilities at the organization level.

  • OmniTrackingGroup

    Represents a group of FlexCard and OmniScript components that have their user interactions tracked together in OmniAnalytics.