SignalActionDetailOutput

actionId
Type: stringFormat: uuid
required
attributes
Type: object | null
required

Type-specific fields. Null when the type defines none.

Properties: 1
availableFrom
Type: string | nullFormat: date-time
required

Start of the delivery window. Null when deliverable at once.
dateCreated
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
endedAt
Type: string | nullFormat: date-time
required

End of the window of the insights that raised the action. Null when no insight raised it.
expired
Type: boolean
required

True when expiresAt has passed and the action is still OPEN or SEEN. Expiry is derived, never a state.
expiresAt
Type: string | nullFormat: date-time
required

End of the delivery window. Null when the action never expires.
initiatorUserId
Type: string | nullFormat: uuid
required

The person who started the action, such as a guide. Null when no person did.
message
Type: string | null
required

What the student is told. Null when the action tells the student nothing in words.
organizationId
Type: stringFormat: uuid
required
resolvedAt
Type: string | nullFormat: date-time
required

When the action reached COMPLETED, SKIPPED or CANCELLED.
seenAt
Type: string | nullFormat: date-time
required

When the student's app displayed the action.
startedAt
Type: string | nullFormat: date-time
required

Start of the window of the insights that raised the action. Null when no insight raised it.
state
Type: stringenum
required
values
OPENSEENCOMPLETEDSKIPPEDCANCELLED
targetUserId
Type: stringFormat: uuid
required

The student the action targets.
tbSessionId
Type: string | null
required

The session the action was raised in. Null when the action has no session.
type
Type: string
required

What kind of action this is, for example Warn for a rule warning.
version
Type: string
required

The version of the action type. Together with type it selects the attributes schema.

PaginatedActionsOutput

PaginatedActionDetailsOutput