Skip to content
The API may change between versions while TTX-Zone is 0.x.

Preview report

GET
/api/v1/ttx/{ttx_id}/aar/preview

What the report will hold, for the screen shown before it exists.

Successful Response

Media typeapplication/json
AarPreviewRead

What the report will hold, before it exists: whether a session it can start from has been held, whether the caller may start it, and the objectives it will cover.

object
can_edit
required
Can Edit
boolean
objectives
required
Objectives
Array<object>
AarPreviewObjective
object
code
required
Code
string
title
required
Title
string
runs
Runs
Array<object>
default:
AarRunOption

A session the report can be written from: the current one or an archived one.

object
current
required
Current
boolean
id
required
Id
string format: uuid
number
required
Number
integer
started_at
required
Started At
string format: date-time
status
required
Status
string
session_started
required
Session Started
boolean

Example

{
"runs": []
}