Skip to main content
Use this parameter to show embedded content as it looks on a modeling branch. For example, to review model changes before you merge them. For embed users with Viewer or Restricted Querier permissions, the branch must be opened to viewers before these users can see the branch’s content. Otherwise, the content loads from the published model.

Syntax

Properties

string
The name of an existing branch. The value is the branch name, not the branch ID. URL-encode special characters, for example / becomes %2F.If the name doesn’t match an active or deleted branch in your organization, the embed login or session redemption fails with a 400 error (Branch not found: <name>). If the name matches a branch that has since been merged or deleted, the content loads from the published model instead, since there’s no branch left to show.For Viewer or Restricted Querier embed users, if the name doesn’t match any branch of the document’s model, or matches a branch that isn’t open to viewers, Omni ignores the parameter, loads the published model, and displays an error:
Ignored the branch “<name>” in this link: it does not exist or you are not authorized to use it

Examples

Start the session on the staging branch
Start the session on a branch named feature/new-metrics