LtiApplicationOutput

LTI Application. The sourcedId represents the application identifier.

applicationType
Type: stringenum
required

Type of the LTI application
values
- learning_app
- assessment
- internal
coverImageUrl
Type: stringFormat: uri
required

URL to the cover image
dateCreated
Type: stringFormat: date-time
required

Timestamp of when the application was created
dateLastModified
Type: stringFormat: date-time
required

Timestamp of when the application was last modified
deploymentId
Type: string
required

Unique deployment identifier
description
Type: string
required

Description of the application
domains
Type: array string[]
required

Domains this application is launched from
idling
Type: stringenum
required

Idling detection feature status
values
- on
- off
isLtiCompliant
Type: boolean
required

Whether the application is LTI compliant
isLtiV1P3Compliant
Type: boolean
required

Whether the application is LTI v1.3 compliant
isRecordingEnabled
Type: boolean
required

Whether session recording is enabled
launchUrl
Type: stringFormat: uri
required

URL to launch the application
logoUrl
Type: stringFormat: uri
required

URL to the application logo
name
Type: string
required

Name of the application
proctoringMode
Type: stringenum
required

Proctoring mode status for this application
values
- on
- off
sourcedId
Type: stringFormat: uuid
required

Unique identifier for the application
status
Type: stringenum
required

Status of an entity in the system
values
- active
- tobedeleted
- inactive
tools
Type: array object[] · LtiToolOutput[]
deprecated
required

Array of LTI tools associated with this application
LTI Tool information and launch configuration
- coverImageUrl
  Type: stringFormat: uri
  required
  
  URL to the tool cover image
- dateCreated
  Type: stringFormat: date-time
  required
  
  Timestamp of when the tool was created
- dateLastModified
  Type: stringFormat: date-time
  required
  
  Timestamp of when the tool was last modified
- deploymentId
  Type: string
  required
  
  Unique deployment identifier for this tool
- description
  Type: string
  required
  
  Description of the LTI tool
- domains
  Type: array string[]
  required
  
  List of domains that this tool is launched from
- idling
  Type: stringenum
  required
  
  Idling detection feature status
  
  values
  on
  off
- isLtiCompliant
  Type: boolean
  required
  
  Whether the tool is LTI compliant
- isLtiV1P3Compliant
  Type: boolean
  required
  
  Whether the tool is LTI v1.3 compliant
- isRecordingEnabled
  Type: boolean
  required
  
  Whether session recording is enabled for this tool
- launchUrl
  Type: stringFormat: uri
  required
  
  URL to which LTI launch messages will be posted
- logoUrl
  Type: stringFormat: uri
  required
  
  URL to the tool logo
- name
  Type: string
  required
  
  Name of the LTI tool
- proctoringMode
  Type: stringenum
  required
  
  Proctoring mode status for this tool
  
  values
  on
  off
- sourcedId
  Type: stringFormat: uuid
  required
  
  Unique identifier for the tool
- status
  Type: stringenum
  required
  
  Status of an entity in the system
  
  values
  active
  tobedeleted
  inactive
- toolType
  Type: stringenum
  deprecated
  required
  
  Type of the LTI tool
  
  values
  learning_app
  assessment
  internal
- version
  Type: string
  required
  
  Version of the tool
- wasteMeter
  Type: stringenum
  required
  
  WasteMeter tracking status for this tool
  
  values
  on
  off
- caliperSupport
  Type: stringenum
  
  Level of Caliper Analytics support (yes, no, partial)
  
  values
  yes
  no
  partial
- clientId
  Type: string | null
  
  Tool-provided client ID used as audience in LTI JWT tokens
- fullDescription
  Type: string | null
  
  Comprehensive description of the tool with detailed information
- gradeRangeEnd
  Type: integer | null
  
  Ending grade level for the tool (e.g., 0 for Kindergarten, 1-12 for grades, 13+ for Higher Ed)
- gradeRangeStart
  Type: integer | null
  
  Starting grade level for the tool (e.g., 0 for Kindergarten, 1-12 for grades, 13+ for Higher Ed)
- idlingThreshold
  Type: integer | null
  
  Threshold in seconds for detecting user idling behavior
- landingUrl
  Type: string | nullFormat: uri
  
  URL to the tool landing page which is the redirect URL after the user has authenticated
- languageSupport
  Type: array string[] | null
  
  Supported languages
- metadata
  Type: object | null
  
  Additional metadata associated with the tool
- publisherName
  Type: string | null
  
  Name of the tool publisher
- subjects
  Type: array string[] | null
  
  Academic subjects or topics covered by the tool
- tags
  Type: array string[] | null
  
  Tool tags for categorization
version
Type: string
required

Application version
wasteMeter
Type: stringenum
required

WasteMeter for this application
values
- on
- off
caliperSupport
Type: stringenum

Level of Caliper Analytics support
values
- yes
- no
- partial
clientId
Type: string | null

Application client ID for LTI JWT tokens
fullDescription
Type: string | null

Comprehensive application description
gradeRangeEnd
Type: integer | null

Ending grade level
gradeRangeStart
Type: integer | null

Starting grade level
homepageUrl
Type: string | nullFormat: uri

Homepage URL for the application
idlingThreshold
Type: integer | null

Threshold in seconds for detecting idling
landingUrl
Type: string | nullFormat: uri

Application landing page URL
languageSupport
Type: array string[] | null

Supported languages
learningAppSpecification
Type: string | null

Per-app specification for AI context
metadata
Type: object | null

Additional metadata associated with the application
- propertyName
  Type: anything
publisherName
Type: string | null

Application publisher name
subjects
Type: array string[] | null

Academic subjects supported
tags
Type: array string[] | null

Application categorization tags