Skip to main content

Objects

Annotation

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
Int!

ID for Annotation

start
Int!

Annotation Start Seconds

end
Int

Annotation End Seconds

marker
Marker!

Associated Marker

userSession
UserSession!

Associated UserSession

note
String

Annotation Note

Authentication

Fields

NameDescription
accessToken
String!

JWT Bearer Token

user
User!

Authenticated user

Marker

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
Int!

ID for Marker

type
MarkerType!

Marker Type

name
String!

Marker Name

abbreviation
String

Marker Name Abbreviation (e.g. for small screen sizes

description
String

Marker Description

color
String!

Marker Color

icon
String

Marker Icon

Media

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
ID!

ID for Media

name
String!

Media Name

mimeType
String!

Media Mime Type

Session

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
ID!

ID for Session

name
String!

Session Name

description
String

Description

status
SessionStatus

Session Status

start
DateTime

Start of Session

end
DateTime

End of Session

editable
Boolean

Default for Session - Editable for Participants

enablePlayer
Boolean

Default for Session - Player Enabled for Participants

displaySampleSolution
Boolean

Default for Session - Sample Solution Displayed

enableLiveAnalysis
Boolean

Default for Session - Annotations are Directly Displayed in Analysis

media
Media

Associated Media File

code
String!
toolbars
[Toolbar!]!

Associated Session

userSessions
[UserSession!]!

Associated User Sessions

Toolbar

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
ID!

ID for Media

session
Session!

Associated Session

markers
[String!]!

User

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
ID!

ID for User

displayName
String

User Display Name

email
String

User Email

UserSession

Fields

NameDescription
createdAt
DateTime!

Creation Date

updatedAt
DateTime!

Date of Last Update

id
Int!

ID for User Session

status
UserSessionStatus!

User Session Status

note
String

User Session Note

session
Session!

Associated Session

owner
User!

Associated User

invitedAt
DateTime!

Invitation Date

annotations
[Annotation!]!

Associated Annotations