Get EEG

GET

/api/v1/ttx/{ttx_id}/eeg

The exercise’s Exercise Evaluation Guide.

Authorizations

• sessionCookie

Responses

200

Successful Response

Media typeapplication/json

EEGRead

The Exercise Evaluation Guide (EEG): what evaluators observe and rate. Deliberately not the design – no needs, risks, sponsor, scope or stop keyword – since the Evaluator role has no access to it.

object

exercise_code

required

Exercise Code

string

exercise_name

required

Exercise Name

string

lead_evaluator

Any of:

string

string

null

null

msel_version

Any of:

integer

integer

null

null

needs_form_status

required

NeedsFormStatus

string

Allowed values: draft ready_for_approval approved

needs_form_version

required

Needs Form Version

integer

notifications

Notifications

Array<object>

default:

ExpectedNotificationRead

A notification regime the team should recognise during the session (services/notification_reference.py): derived from the notification requirements the objectives cite.

object

description_en

required

Description En

string

description_es

required

Description Es

string

framework

required

Framework

string

framework_label_en

required

Framework Label En

string

framework_label_es

required

Framework Label Es

string

milestones

required

Milestones

Array<object>

NotificationMilestoneRead

object

clock_en

required

Clock En

string

clock_es

required

Clock Es

string

deadline_en

required

Deadline En

string

deadline_es

required

Deadline Es

string

recipient_en

required

Recipient En

string

recipient_es

required

Recipient Es

string

stage_en

required

Stage En

string

stage_es

required

Stage Es

string

objective_codes

required

Objective Codes

Array<string>

reference

required

Reference

string

requirement_id

required

Requirement Id

string

objectives

required

Objectives

Array<object>

EEGObjective

object

achieve_at_least

Any of:

integer

integer

null

null

achieved_note

Achieved Note

string

""

capability

required

Capability

Capabilities an exercise can validate – TTX-Zone’s own taxonomy.

string

Allowed values: detection_triage_escalation incident_classification crisis_decision_making regulatory_notification internal_external_comms cross_unit_coordination third_party_supply_chain continuity_recovery legal_forensics

code

required

Code

string

due_phases

Due Phases

Array<object>

default:

EEGDuePhase

A phase the objective (or one of its decisions) is due by the end of – its deadline, from the MSEL.

object

code

required

Code

string

end_offset

required

End Offset

integer

name

required

Name

string

evaluators

Evaluators

Array<string>

default:

evidence

required

Evidence

string

evidence_items

Evidence Items

Array<string>

default:

expected_actions

Expected Actions

Array<object>

default:

EEGExpectedAction

An MSEL expected action, listed under each objective its inject evaluates – an observation point with its window.

object

code

required

Code

string

description

required

Description

string

expected_within_minutes

required

Any of:

integer

integer

null

null

inject_code

required

Inject Code

string

inject_title

required

Inject Title

string

responsible_role

required

Responsible Role

string

id

required

Id

string format: uuid

not_achieved

Not Achieved

string

""

observation_points

required

Observation Points

Array<string>

partially_achieved

Partially Achieved

string

""

points

Points

Array<object>

default:

EEGPoint

An observation point of a definitive EEG (the conduct prep’s), with what each rating level means for it.

object

action_code

Action Code

string

""

criteria

required

Criteria

object

key

additional properties

string

expected_within_minutes

Any of:

integer

integer

null

null

id

required

Id

string format: uuid

inject_code

Inject Code

string

""

inject_title

Inject Title

string

""

kind

required

Kind

string

responsible_role

Responsible Role

string

""

text

required

Text

string

statement

required

Statement

string

time_box_minutes

Any of:

integer

integer

null

null

title

Title

string

""

plan_reopened

Plan Reopened

boolean

plan_version

Any of:

integer

integer

null

null

rating_scale

Rating Scale

Array<string>

default: P,S,M,U

source

Source

string

default: derived

tlp

required

Tlp

FIRST Traffic Light Protocol 2.0 labels.

string

Allowed values: clear green amber amber_strict red

ttx_id

required

Ttx Id

string format: uuid

Example

{
  "needs_form_status": "draft",
  "notifications": [],
  "objectives": [
    {
      "achieved_note": "",
      "capability": "detection_triage_escalation",
      "due_phases": [],
      "evaluators": [],
      "evidence_items": [],
      "expected_actions": [],
      "not_achieved": "",
      "partially_achieved": "",
      "points": [],
      "title": ""
    }
  ],
  "plan_reopened": false,
  "rating_scale": [
    "P",
    "S",
    "M",
    "U"
  ],
  "source": "derived",
  "tlp": "clear"
}