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

End run

POST
/api/v1/ttx/{ttx_id}/run/end

The exercise is over (EndEx).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
RunRead
object
can_control
required
Can Control
boolean
can_delete
Can Delete
boolean
control
required
Any of:
RunControlRead
object
injects
required
Injects
Array<object>
RunControlInjectRead
object
branch_action_code
required
Any of:
string
code
required
Code
string
contingent_purpose
required
Contingent Purpose
string
due_minute
required
Any of:
integer
expected_actions
required
Expected Actions
Array<object>
RunActionRead

An expected action of an inject and what the Controller saw of it.

object
code
required
Code
string
description
required
Description
string
expected_within_minutes
required
Any of:
integer
mark
required
Any of:
ActionMark
string
Allowed values: observed partial not_observed
marked_at
required
Any of:
string format: date-time
note
required
Note
string
responsible_role
required
Responsible Role
string
format
InjectFormat

What an inject is, and so what it asks of the table: an inject that evaluates objectives (INJ), a discussion slide – a debrief or reflection prompt, no objective, not in the EEG nor the coverage (DSC) –, or a poll the Players vote on, outside the evaluation too (POL).

string
default: inject
Allowed values: inject discussion poll
kind
required
InjectKind
string
Allowed values: mandatory contingent
offset_minutes
required
Any of:
integer
phase_code
required
Any of:
string
reason
required
Reason
string
room_codes
Room Codes
Array<string>
default:
state
required
State
string
Allowed values: pending released skipped
suggested
required
Suggested
boolean
title
required
Title
string
trigger_condition
required
Trigger Condition
string
msel
required
Msel
object
key
additional properties
any
phases
required
Phases
Array<object>
RunControlPhaseRead
object
code
required
Code
string
covered_questions
required
Covered Questions
Array<integer>
end_offset
required
End Offset
integer
key_questions
required
Key Questions
Array<string>
name
required
Name
string
question_places
Question Places
Array<object>
default:
RunQuestionPlaceRead

In rooms, each place asks and covers a phase’s key questions on its own: the positions, like released_questions and covered_questions.

object
covered_questions
required
Covered Questions
Array<integer>
released_questions
required
Released Questions
Array<integer>
room_code
required
Room Code
string
released_questions
required
Released Questions
Array<integer>
start_offset
required
Start Offset
integer
current_phase_code
required
Any of:
string
cursor
required
Cursor
string
decisions
Decisions
Array<object>
default:
RunDecisionRead

A decision of the table’s log, as recorded (and maybe edited).

object
at
required
At
string format: date-time
author
required
Author
string
edited
required
Edited
boolean
id
required
Id
string
inject_code
required
Inject Code
string
mine
required
Mine
boolean
poll_id
Any of:
string
role
required
Role
string
room_code
required
Any of:
string
text
required
Text
string
ended_at
required
Any of:
string format: date-time
endex_released_at
Any of:
string format: date-time
facilitation
required
Any of:
RunFacilitationRead

The Facilitator’s script for the phase in play: its key questions (and which were put to the table) and the inject’s facilitator notes.

object
covered_questions
required
Covered Questions
Array<integer>
facilitator_notes
required
Facilitator Notes
string
inject_code
required
Any of:
string
key_questions
required
Key Questions
Array<string>
phase_code
required
Phase Code
string
phase_name
required
Phase Name
string
question_places
Question Places
Array<object>
default:
RunQuestionPlaceRead

In rooms, each place asks and covers a phase’s key questions on its own: the positions, like released_questions and covered_questions.

object
covered_questions
required
Covered Questions
Array<integer>
released_questions
required
Released Questions
Array<integer>
room_code
required
Room Code
string
released_questions
required
Released Questions
Array<integer>
incident_date
required
Any of:
string format: date
incident_start
required
Any of:
string format: time
inject_timer_at
Any of:
string format: date-time
inject_timer_paused_seconds
Inject Timer Paused Seconds
integer
0
injects
required
Injects
Array<object>
RunInjectRead

A delivered inject, safe for the Players.

object
artifact
Any of:
InjectArtifact

An inject’s content rendered as a simulated artifact. The body is the inject’s own content; these are the template’s other fields, whose meaning follows kind (email: from, address, to, subject, date; press release: outlet, dateline, headline, date; social post: author, handle, date; chat message: sender, channel, date). All plain text: the Playground draws them, nothing is ever rendered as markup.

object
kind
required
ArtifactKind

How the Playground renders an inject’s content as a simulated artifact (a template drawn by the app, never uploaded markup).

string
Allowed values: email press_release social_post chat_message
location
Location
string
"" <= 255 characters
recipient
Recipient
string
"" <= 255 characters
sender
Sender
string
"" <= 255 characters
sender_address
Sender Address
string
"" <= 255 characters
subject
Subject
string
"" <= 255 characters
timestamp
Timestamp
string
"" <= 64 characters
attachment_notes
required
Attachment Notes
Array<string>
code
required
Code
string
content
required
Content
string
delivery_method
required
DeliveryMethod
string
Allowed values: email phone chat ticket security_tool in_person briefing media document
files
Files
Array<object>
default:
InjectFileRead
object
description
required
Description
string
id
required
Id
string format: uuid
name
required
Name
string
sha256
required
Sha256
string
size_bytes
required
Size Bytes
integer
format
InjectFormat

What an inject is, and so what it asks of the table: an inject that evaluates objectives (INJ), a discussion slide – a debrief or reflection prompt, no objective, not in the EEG nor the coverage (DSC) –, or a poll the Players vote on, outside the evaluation too (POL).

string
default: inject
Allowed values: inject discussion poll
images
required
Images
Array<object>
InjectImageRead
object
caption
required
Caption
string
height
required
Height
integer
id
required
Id
string format: uuid
width
required
Width
integer
phase_code
required
Any of:
string
questions
required
Questions
Array<object>
RunQuestionRead
object
covered
required
Covered
boolean
room_code
Any of:
string
text
required
Text
string
recipients
required
Recipients
Array<string>
released_at
required
Released At
string format: date-time
room_codes
Room Codes
Array<string>
default:
scenario_minute
required
Any of:
integer
sender
required
Any of:
RunSenderRead
object
channel
required
Any of:
DeliveryMethod
string
Allowed values: email phone chat ticket security_tool in_person briefing media document
name
required
Name
string
type
required
ActorType
string
Allowed values: soc csirt authority media supplier customer threat_actor internal other
title
required
Title
string
meters
Meters
Array<object>
default:
RunMeterGroupRead

The meters of one place: the table, or a room (room_code; null, in rooms: the main room).

object
decisions
required
Decisions
integer
meters
required
Meters
Array<object>
RunMeterRead
object
key
required
Key
string
most
required
Most
integer
name
required
Name
string
total
required
Total
integer
room_code
required
Any of:
string
meters_shown
Meters Shown
boolean
msel_ready
required
Msel Ready
boolean
paused_at
required
Any of:
string format: date-time
paused_seconds
required
Paused Seconds
integer
phases
required
Phases
Array<object>
RunPhaseRead

A phase as the table sees it: its name only once it has begun.

object
code
required
Code
string
headline
required
Any of:
string
name
required
Any of:
string
number
required
Number
integer
state
required
State
string
Allowed values: done current upcoming
plan_ready
required
Plan Ready
boolean
polls
Polls
Array<object>
default:
RunPollRead

A question put to the Players’ vote: the tally, never who voted.

object
decision_id
Any of:
string
id
required
Id
string
inject_code
required
Inject Code
string
my_vote
Any of:
integer
open
required
Open
boolean
options
required
Options
Array<object>
RunPollOptionRead
object
impacts
Impacts
Array<object>
default:
RunPollImpactRead
object
level
required
Level
integer
name
required
Name
string
outcome
Any of:
string
text
required
Text
string
votes
required
Votes
integer
outcome
Any of:
string
outcome_option
Any of:
integer
planned
Planned
boolean
question
required
Question
string
results_visible
Results Visible
boolean
default: true
room_code
required
Any of:
string
voters
required
Voters
integer
presence
required
Presence
Array<object>
RunPresenceRead

Someone on the Playground right now. A Player sees the other Players by name, and only how many of each role the team is.

object
name
required
Any of:
string
role
required
Role
string
presence_counts
Presence Counts
object
key
additional properties
integer
real_world_at
Any of:
string format: date-time
real_world_by
Any of:
string
rooms
Any of:
RunRoomsRead

An exercise played in rooms. A Player gets only their own room (and the injects of it and of the main room); the team gets every room and every delivered inject; the Controller also each Player, to move them.

object
default_room_code
Any of:
string
in_main
required
In Main
integer
main_history
required
Main History
Array<string>
main_projected
required
Any of:
string
me
Any of:
RunMeRead

A Player’s own seat and where the Controller has them now.

object
location
required
Location
string
Allowed values: main room
room_code
required
Any of:
string
room_name
required
Any of:
string
players
Any of:
Array<object>
RunRoomPlayerRead

A Player and where they are (the Controller’s view, to move them).

object
location
required
Location
string
Allowed values: main room
name
required
Name
string
room_code
required
Any of:
string
user_id
required
User Id
string format: uuid
rooms
required
Rooms
Array<object>
RunRoomRead
object
code
required
Code
string
in_main
required
In Main
integer
name
required
Name
string
players
required
Players
integer
run_number
Any of:
integer
scenario_summary
required
Scenario Summary
string
scenario_title
required
Scenario Title
string
seq
required
Seq
integer
session_time
required
Any of:
string format: time
started_at
required
Any of:
string format: date-time
state
required
State
string
Allowed values: not_started live paused ended stopped
stop_keyword
required
Stop Keyword
string
stop_reason
required
Stop Reason
string
time_compression
required
Time Compression
integer

Example 

{
  "can_delete": false,
  "control": {
    "injects": [
      {
        "expected_actions": [
          {
            "mark": "observed"
          }
        ],
        "format": "inject",
        "kind": "mandatory",
        "room_codes": [],
        "state": "pending"
      }
    ],
    "phases": [
      {
        "question_places": []
      }
    ]
  },
  "decisions": [],
  "facilitation": {
    "question_places": []
  },
  "inject_timer_paused_seconds": 0,
  "injects": [
    {
      "artifact": {
        "kind": "email",
        "location": "",
        "recipient": "",
        "sender": "",
        "sender_address": "",
        "subject": "",
        "timestamp": ""
      },
      "delivery_method": "email",
      "files": [],
      "format": "inject",
      "room_codes": [],
      "sender": {
        "channel": "email",
        "type": "soc"
      }
    }
  ],
  "meters": [],
  "meters_shown": false,
  "phases": [
    {
      "state": "done"
    }
  ],
  "polls": [],
  "presence_counts": {},
  "rooms": {
    "me": {
      "location": "main"
    },
    "players": [
      {
        "location": "main"
      }
    ]
  },
  "state": "not_started"
}