Magidoc

Scenario
Object

Represents a set of steps and sequences that a User can interact with (versioned).

Fields

#

activeSessionsCount

Number of active sessions for this scenario.

activeWorkInstructionSessionCount

Number of active work instructions sessions for this scenario.

author

The User that authored the Scenario.

catalogs

A list of Scenario ScenarioCatalogs associated with the Scenario.

createdAt

Identifies the date and time when the object was created.

currentRelease

The ScenarioRelease to be used when creating new ScenarioSessions associated with the Scenario.

databaseId

Identifies the primary key from the data store.

deferredLink

Deferred link for active scenario content.

deletedAt

Identifies the date and time when the object was deleted.

description

The description of the Scenario.

guid

Global ID of the Scenario record. This should be persistent if data is migrated and is recommended to use.

id

ID !
Non-null

ID of the object.

lastAccessedBy

User of most recently started scenario session.

latestRelease

The last ScenarioRelease associated with the Scenario.

name

The name of the Scenario.

nameForLog

Object name to be identified in Audit Logs.

nonOriginGroups

A list of non default Groups that can access the Scenario.

organization

The Organization associated with the Scenario.

originGroup

The origin Group associated with the Scenario.

path

Non-null

The relative path of the object.

permissions

Non-null

A list of Permissions associated with the currently authenticated User and the Scenario.

planUsageStatus

The Scenario's plan usage status.

project

The Project associated with the Scenario.

public

Whether the Scenario belongs to a public Catalog.

publishedAt

The date and time when the first ScenarioRelease associated with the Scenario was published.

qrCodeImageLink

Link to download qr code for the current release.

recipientGroups

A list of Groups that can access the Scenario.

recipientGroupsWithoutOriginGroup

A list of Groups except origin group that can access the Scenario.

releasedAt

The date and time when the Scenario was first released.

releases

A list of ScenarioReleases associated with the Scenario.

resourcePermissions

The resource permissions for the Scenario.

scopeFile

Attached scope file of latest version.

sequences

A list of ScenarioSequences associated with the ScenarioRelease.

sessions

A list of ScenarioSessions associated with the Scenario.

sessionsCount

Number of ScenarioSessions associated with the Scenario.

settings

Non-null

The settings associated with the object.

state

The state of the Scenario based on the associated Project.

steps

A list of ScenarioSteps associated with the ScenarioRelease.

totalSteps

The number of steps within the scenario.

updatedAt

Identifies the date and time when the object was last updated.

url

Non-null

The url of the object.

version

The most recent version of the scenario.

workInstructionSessions

A list of ScenarioSessionParts associated with the Scenario.

Interfaces

#

Also implements NodeInterface .

Usages

#

References

#