Magidoc

ScenarioSession
Object

Represents an execution of a ScenarioRelease.

Fields

#

calls

A list of CallSessions associated with the ScenarioSession.

completedItems

A list of Step Items completed in the current Scenario Session.

completedSteps

A list of Steps completed in the current Scenario Session.

createdAt

Identifies the date and time when the object was created.

databaseId

Identifies the primary key from the data store.

deletedAt

Identifies the date and time when the object was deleted.

duration

The duration of the ScenarioSession in seconds.

endedAt

The date and time that the ScenarioSession ended.

events

A list of ScenarioSessionEvents associated with the ScenarioSession.

externalData

3rd party data associated with the ScenarioSession.

id

ID !
Non-null

ID of the object.

idleDuration

The duration of the ScenarioSession where User was idle.

nameForLog

Object name to be identified in Audit Logs.

numberOfStepsPossible

The number of steps possible to view during the ScenarioSession.

numberOfStepsViewed

The number of steps viewed during the ScenarioSession.

organization

The Organization associated with the ScenarioSession.

originGroup

The origin group of the parent Scenario at time of creation.

participants

[ User !]

The list of users that added events to the ScenarioSession.

parts

A list of ScenarioSessionParts associated with the ScenarioSession.

path

Non-null

The relative path of the object.

percentOfStepsCompleted

The percentage of steps completed during the ScenarioSession (i.e. all checklist items have been completed).

percentOfStepsViewed

The percentage of steps viewed during the ScenarioSession.

permissions

Non-null

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

progress

Status that states if a scenario has been completed.

quizData

Quiz related data.

recipientGroups

The recipient groups of the parent Scenario at time of creation.

scenario

The Scenario associated with the ScenarioSession.

scenarioName

The name of the scenario associated with the Scenario Session.

scenarioRelease

The ScenarioRelease associated with the ScenarioSession.

scenarioReleaseVersion

The version of the ScenarioRelease.

scenarioReleaseWorkInstructionType

The type of ScenarioRelease.

sessionName

The user-defined name of the session.

sessionType

An ArContent session type to filter the session.

settings

Non-null

The settings associated with the object.

startedAt

The date and time that the ScenarioSession began.

state

The state of the ScenarioSession.

steps

A list of ScenarioSessionSteps associated with the ScenarioSession.

updatedAt

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

url

Non-null

The url of the object.

user

The User associated with the ScenarioSession.

Interfaces

#

Also implements NodeInterface .

Usages

#

References

#

  • Field scenarioSession from Call