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

Save conduct prep

PUT
/api/v1/ttx/{ttx_id}/conduct-prep

Save the session plan as a whole.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ConductPrepSaveRequest

PUT /ttx/{ttx_id}/conduct-prep – the whole plan in one save, like the MSEL: a DRAFT may be incomplete (the validation report judges it), collections are full-replace keyed by id, revision is the one the client edited.

object
after_action_meeting_days
After Action Meeting Days
integer
default: 21 <= 365
attendees
Attendees
Array<object>
<= 30 items
AttendeeInput
object
confirmed
Confirmed
boolean
fallback
Any of:
AbsenceFallback

What happens if a key decision maker can’t attend.

string
Allowed values: substitute postpone proceed
id
Any of:
string format: uuid
name
Name
string
"" <= 255 characters
role
Role
string
"" <= 255 characters
substitute
Substitute
string
"" <= 255 characters
user_id
Any of:
string format: uuid
briefed_controller_ids
Briefed Controller Ids
Array<string>
<= 50 items
briefing_checklist
Briefing Checklist
Array<string>
<= 20 items
briefing_date
Any of:
string format: date
briefing_notes
Briefing Notes
string
"" <= 5000 characters
data_collection_methods
Data Collection Methods
Array<string>
<= 20 items
data_collection_other
Data Collection Other
string
"" <= 255 characters
debrief_days
Debrief Days
integer
0 <= 365
documents_reviewed
Documents Reviewed
Array<string>
<= 20 items
draft_aar_days
Draft Aar Days
integer
default: 14 <= 365
dry_run_date
Any of:
string format: date
dry_run_done
Dry Run Done
boolean
eeg
Eeg
Array<object>
<= 40 items
EegObjectiveInput

The points of one definitive EEG. EEGs themselves aren’t created or removed by a save – they follow the needs analysis’ objectives (the re-seed adds and drops them).

object
id
required
Id
string format: uuid
points
Points
Array<object>
<= 20 items
EegPointInput
object
criteria_m
Criteria M
string
"" <= 5000 characters
criteria_p
Criteria P
string
"" <= 5000 characters
criteria_s
Criteria S
string
"" <= 5000 characters
criteria_u
Criteria U
string
"" <= 5000 characters
id
Any of:
string format: uuid
text
Text
string
"" <= 5000 characters
evaluators
Evaluators
Array<object>
<= 20 items
EvaluatorInput
object
areas
Areas
Array<string>
<= 20 items
briefed
Briefed
boolean
id
Any of:
string format: uuid
objective_ids
Objective Ids
Array<string>
<= 20 items
user_id
required
User Id
string format: uuid
findings
Findings
Array<object>
<= 40 items
FindingInput
object
description
Description
string
"" <= 5000 characters
found_in
FindingSource

Which review of the design found it: the sponsor’s or another stakeholder’s review of the drafts, the Final Planning Meeting or the dry run.

string
default: dry_run
Allowed values: design_review planning_meeting dry_run
id
Any of:
string format: uuid
inject_id
Any of:
string format: uuid
kind
FindingKind

What a review found wrong with the design.

string
default: other
Allowed values: ambiguous_inject overloaded_phase unrealistic_timing other
phase_id
Any of:
string format: uuid
resolved
Resolved
boolean
fpm_attendees
Fpm Attendees
string
"" <= 5000 characters
fpm_date
Any of:
string format: date
fpm_done
Fpm Done
boolean
fpm_notes
Fpm Notes
string
"" <= 5000 characters
hot_wash_days
Hot Wash Days
integer
0 <= 365
invitation_sent_on
Any of:
string format: date
invitation_text
Invitation Text
string
"" <= 20000 characters
log_keeper_id
Any of:
string format: uuid
logistics_checklist
Logistics Checklist
Array<string>
<= 20 items
meeting_link
Meeting Link
string
"" <= 2048 characters
modality
Any of:
SessionModality
string
Allowed values: in_person remote hybrid
ratings_due_days
Ratings Due Days
integer
default: 3 <= 365
revision
required
Revision
integer
room
Room
string
"" <= 255 characters
session_date
Any of:
string format: date
session_notes
Session Notes
string
"" <= 5000 characters
session_time
Any of:
string format: time
stop_procedure
Stop Procedure
string
"" <= 5000 characters
timezone
Timezone
string
"" <= 64 characters
venue
Venue
string
"" <= 255 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ConductPrepRead
object
after_action_meeting_days
required
After Action Meeting Days
integer
attendees
required
Attendees
Array<object>
AttendeeRead
object
confirmed
required
Confirmed
boolean
fallback
required
Any of:
AbsenceFallback

What happens if a key decision maker can’t attend.

string
Allowed values: substitute postpone proceed
id
required
Id
string format: uuid
name
required
Name
string
role
required
Role
string
substitute
required
Substitute
string
user_id
Any of:
string format: uuid
briefed_controller_ids
required
Briefed Controller Ids
Array<string>
briefing_checklist
required
Briefing Checklist
Array<string>
briefing_date
required
Any of:
string format: date
briefing_notes
required
Briefing Notes
string
context
required
ConductPrepContext

What the plan is checked against, read-only here.

object
date_window_end
required
Any of:
string format: date
date_window_start
required
Any of:
string format: date
exercise_controllers
required
Exercise Controllers
Array<object>
PersonOption
object
full_name
required
Full Name
string
user_id
required
User Id
string format: uuid
exercise_evaluators
required
Exercise Evaluators
Array<object>
PersonOption
object
full_name
required
Full Name
string
user_id
required
User Id
string format: uuid
exercise_players
required
Exercise Players
Array<object>
PlayerOption

A Player with access to the exercise: when they used the invitation (invited_at, None if they were added another way) and when access was granted (joined_at).

object
email
required
Email
string
full_name
required
Full Name
string
invited_at
required
Any of:
string format: date-time
joined_at
required
Joined At
string format: date-time
user_id
required
User Id
string format: uuid
injects
required
Injects
Array<object>
CodedOption
object
code
required
Code
string
id
required
Id
string format: uuid
title
required
Title
string
lead_evaluator
required
Any of:
PersonOption
object
full_name
required
Full Name
string
user_id
required
User Id
string format: uuid
mandatory_injects
required
Mandatory Injects
integer
mandatory_injects_validated
required
Mandatory Injects Validated
integer
max_duration_hours
required
Any of:
integer
msel_duration_minutes
required
Any of:
integer
msel_exercise_start
required
Any of:
string format: time
msel_ready_version
required
Any of:
integer
msel_status
required
Any of:
MselStatus
string
Allowed values: draft in_review ready
needs_form_status
required
NeedsFormStatus
string
Allowed values: draft ready_for_approval approved
needs_form_version
required
Needs Form Version
integer
participating_areas
required
Participating Areas
Array<string>
pending_access_requests
required
Pending Access Requests
integer
phases
required
Phases
Array<object>
CodedOption
object
code
required
Code
string
id
required
Id
string format: uuid
title
required
Title
string
stop_exercise_keyword
required
Stop Exercise Keyword
string
team_members
required
Team Members
Array<object>
PersonOption
object
full_name
required
Full Name
string
user_id
required
User Id
string format: uuid
tlp
required
Tlp

FIRST Traffic Light Protocol 2.0 labels.

string
Allowed values: clear green amber amber_strict red
data_collection_methods
required
Data Collection Methods
Array<string>
data_collection_other
required
Data Collection Other
string
debrief_days
required
Debrief Days
integer
documents_reviewed
required
Documents Reviewed
Array<string>
draft_aar_days
required
Draft Aar Days
integer
drift
required
ConductPrepDrift
object
msel_changed
Msel Changed
boolean
needs_changed
Needs Changed
boolean
dry_run_date
required
Any of:
string format: date
dry_run_done
required
Dry Run Done
boolean
editable
required
Editable
boolean
eeg
required
Eeg
Array<object>
EegObjectiveRead
object
capability
required
Capability
string
code
required
Code
string
id
required
Id
string format: uuid
objective_id
required
Objective Id
string format: uuid
orphaned
Orphaned
boolean
points
required
Points
Array<object>
EegPointRead
object
criteria_m
required
Criteria M
string
criteria_p
required
Criteria P
string
criteria_s
required
Criteria S
string
criteria_u
required
Criteria U
string
expected_within_minutes
required
Any of:
integer
id
required
Id
string format: uuid
kind
required
EegPointKind

Where an observation point came from: a clause of the objective’s success criterion, an expected action of the READY MSEL, a notification requirement the objective cites, or written here.

string
Allowed values: criterion expected_action notification custom
responsible_role
required
Responsible Role
string
source_action_code
required
Source Action Code
string
source_action_id
required
Any of:
string format: uuid
source_inject_code
required
Source Inject Code
string
source_inject_title
required
Source Inject Title
string
source_requirement_id
Source Requirement Id
string
""
source_status
Source Status
string
default: custom
Allowed values: custom current changed orphaned
source_text
required
Source Text
string
text
required
Text
string
statement
required
Statement
string
title
Title
string
""
evaluators
required
Evaluators
Array<object>
EvaluatorRead
object
areas
required
Areas
Array<string>
briefed
required
Briefed
boolean
full_name
required
Full Name
string
id
required
Id
string format: uuid
objective_ids
required
Objective Ids
Array<string>
user_id
required
User Id
string format: uuid
exercise_code
required
Exercise Code
string
findings
required
Findings
Array<object>
FindingRead
object
description
required
Description
string
found_in
FindingSource

Which review of the design found it: the sponsor’s or another stakeholder’s review of the drafts, the Final Planning Meeting or the dry run.

string
default: dry_run
Allowed values: design_review planning_meeting dry_run
id
required
Id
string format: uuid
inject_id
required
Any of:
string format: uuid
kind
required
FindingKind

What a review found wrong with the design.

string
Allowed values: ambiguous_inject overloaded_phase unrealistic_timing other
phase_id
required
Any of:
string format: uuid
resolved
required
Resolved
boolean
fpm_attendees
required
Fpm Attendees
string
fpm_date
required
Any of:
string format: date
fpm_done
required
Fpm Done
boolean
fpm_msel_version
required
Any of:
integer
fpm_notes
required
Fpm Notes
string
hot_wash_days
required
Hot Wash Days
integer
id
required
Id
string format: uuid
invitation_sent_on
required
Any of:
string format: date
invitation_text
required
Invitation Text
string
log_keeper_id
required
Any of:
string format: uuid
logistics_checklist
required
Logistics Checklist
Array<string>
meeting_link
required
Meeting Link
string
modality
required
Any of:
SessionModality
string
Allowed values: in_person remote hybrid
ratings_due_days
required
Ratings Due Days
integer
ready_at
required
Any of:
string format: date-time
ready_by
required
Ready By
string
ready_by_id
required
Any of:
string format: uuid
revision
required
Revision
integer
room
required
Room
string
seeded_msel_version
required
Any of:
integer
seeded_needs_form_version
required
Seeded Needs Form Version
integer
session_date
required
Any of:
string format: date
session_notes
required
Session Notes
string
session_starts_at
required
Any of:
string format: date-time
session_time
required
Any of:
string format: time
status
required
ConductPrepStatus
string
Allowed values: draft ready
stop_procedure
required
Stop Procedure
string
timezone
required
Timezone
string
ttx_id
required
Ttx Id
string format: uuid
updated_at
required
Updated At
string format: date-time
validation
required
ValidationReport

ready blocks DRAFT -> READY_FOR_APPROVAL, approved additionally blocks READY_FOR_APPROVAL -> APPROVED; warnings never block.

object
approved
required
Approved
Array<object>
ValidationIssue

One rule a form breaks. section is the form section (0-9) to send the user to; field the field within it; item_id the row (need, objective) or value (capability, approver kind) concerned, if any.

object
code
required
Code
string
field
Any of:
string
item_id
Any of:
string
section
required
Section
integer
ready
required
Ready
Array<object>
ValidationIssue

One rule a form breaks. section is the form section (0-9) to send the user to; field the field within it; item_id the row (need, objective) or value (capability, approver kind) concerned, if any.

object
code
required
Code
string
field
Any of:
string
item_id
Any of:
string
section
required
Section
integer
warnings
required
Warnings
Array<object>
ValidationIssue

One rule a form breaks. section is the form section (0-9) to send the user to; field the field within it; item_id the row (need, objective) or value (capability, approver kind) concerned, if any.

object
code
required
Code
string
field
Any of:
string
item_id
Any of:
string
section
required
Section
integer
venue
required
Venue
string
version
required
Version
integer

Example 

{
  "attendees": [
    {
      "fallback": "substitute"
    }
  ],
  "context": {
    "msel_status": "draft",
    "needs_form_status": "draft",
    "tlp": "clear"
  },
  "drift": {
    "msel_changed": false,
    "needs_changed": false
  },
  "eeg": [
    {
      "orphaned": false,
      "points": [
        {
          "kind": "criterion",
          "source_requirement_id": "",
          "source_status": "custom"
        }
      ],
      "title": ""
    }
  ],
  "findings": [
    {
      "found_in": "design_review",
      "kind": "ambiguous_inject"
    }
  ],
  "modality": "in_person",
  "status": "draft"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}