JourneyView
A published journey as a runner or menu reads it: no source, drafts or revision. Authoring uses the Journey type.
Fields
TypeID of the journey (prefix jny).
The journey's stable handle, unique within the tenant.
Display title from the published definition, else the handle.
Icon token from the published definition; null when it declares none.
One-line summary from the published definition; null when it has none.
Distribution scope: the caller's own PERSONAL journey, a TEAM's, or the INSTANCE's.
Possible values (3)
PERSONALOwned by one user and visible only to them. Self-service: authoring it needs journey:personal rather than journey:write, and journey:write is not a backdoor into someone else's personal journey.
TEAMOffered to the members of the teams it is assigned to; at least one team is required. Authoring it needs journey:write.
INSTANCEOffered to everyone in the tenant whose permissions cover its requiredDomains. The default scope when none is given, and what bundled journeys use; authoring it needs journey:write.
TypeID of the published version served (prefix jnv).
Compiled Journey JSON of the published version for the Surfaces runtime; null when access.usable is false.
Whether the caller can run the journey, and which domains are missing if not.
Referenced by (2)
Exact type SDL
"""
A published journey as a runner or menu reads it: no source, drafts or revision. Authoring uses the Journey type.
"""
type JourneyView {
"""TypeID of the journey (prefix `jny`)."""
id: JourneyID!
"""The journey's stable handle, unique within the tenant."""
handle: String!
"""Display title from the published definition, else the handle."""
title: String!
"""Icon token from the published definition; null when it declares none."""
icon: String
"""One-line summary from the published definition; null when it has none."""
summary: String
"""
Distribution scope: the caller's own PERSONAL journey, a TEAM's, or the INSTANCE's.
"""
scope: JourneyScope!
"""TypeID of the published version served (prefix `jnv`)."""
versionId: JourneyVersionID!
"""
Compiled Journey JSON of the published version for the Surfaces runtime; null when access.usable is false.
"""
definition: String
"""
Whether the caller can run the journey, and which domains are missing if not.
"""
access: ViewAccess!
}