Save report

PUT

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

Save the after-action report as a whole.

Authorizations

• csrfToken
• sessionCookie

Request Body^required

Media typeapplication/json

AarSaveRequest

The whole report in one save (autosaved). Objectives are the plan’s – only their text and level change; actions are full-replace keyed by id. revision is the one the client edited.

object

actions

Actions

Array<object>

<= 300 items

ImprovementActionInput

object

action

Action

string

"" <= 20000 characters

due_date

Any of:

string

string format: date

null

null

finding

Finding

string

"" <= 20000 characters

id

Any of:

string

string format: uuid

null

null

objective_code

Any of:

string

string

<= 24 characters

null

null

owner

Owner

string

"" <= 255 characters

owner_area

Owner Area

string

"" <= 255 characters

status

ImprovementStatus

string

default: open

Allowed values: open in_progress done cancelled

status_note

Status Note

string

"" <= 1000 characters

conclusions

Conclusions

string

"" <= 20000 characters

executive_summary

Executive Summary

string

"" <= 20000 characters

objectives

Objectives

Array<object>

<= 100 items

AarObjectiveInput

object

analysis

Analysis

string

"" <= 20000 characters

id

required

Id

string format: uuid

improvements

Improvements

string

"" <= 20000 characters

overall

Any of:

RatingLevel

RatingLevel

The common rating scale: performed without challenges (P), with some (S), with major ones (M), or unable to be performed (U).

string

Allowed values: P S M U

null

null

strengths

Strengths

string

"" <= 20000 characters

revision

required

Revision

integer

scenario_summary

Scenario Summary

string

"" <= 20000 characters

Responses

200

Successful Response

Media typeapplication/json

AarRead

object

actions

required

Actions

Array<object>

ImprovementActionRead

object

action

required

Action

string

code

required

Code

string

due_date

required

Any of:

string

string format: date

null

null

finding

required

Finding

string

id

required

Id

string format: uuid

objective_code

required

Any of:

string

string

null

null

overdue

required

Overdue

boolean

owner

required

Owner

string

owner_area

required

Owner Area

string

retest

Any of:

RetestRead

RetestRead

The later exercise that re-tests an improvement action, and which of its objectives (none: the exercise as a whole).

object

objective_code

Any of:

string

string

null

null

objective_id

Any of:

string

string format: uuid

null

null

objective_title

Any of:

string

string

null

null

ttx_code

required

Ttx Code

string

ttx_id

required

Ttx Id

string format: uuid

ttx_name

required

Ttx Name

string

null

null

status

required

ImprovementStatus

string

Allowed values: open in_progress done cancelled

status_note

required

Status Note

string

updated_at

required

Updated At

string format: date-time

can_edit

required

Can Edit

boolean

can_follow_up

Can Follow Up

boolean

can_see_session

Can See Session

boolean

conclusions

required

Conclusions

string

executive_summary

required

Executive Summary

string

finalized_at

required

Any of:

string

string format: date-time

null

null

finalized_by

required

Finalized By

string

id

required

Id

string format: uuid

objectives

required

Objectives

Array<object>

AarObjectiveRead

object

analysis

required

Analysis

string

id

required

Id

string format: uuid

improvements

required

Improvements

string

objective_code

required

Objective Code

string

overall

required

Any of:

RatingLevel

RatingLevel

The common rating scale: performed without challenges (P), with some (S), with major ones (M), or unable to be performed (U).

string

Allowed values: P S M U

null

null

session_ratings

required

Session Ratings

Array<object>

SessionRatingRead

A rating the session gave a point of the objective, for reference.

object

evaluator

required

Evaluator

string

level

required

RatingLevel

The common rating scale: performed without challenges (P), with some (S), with major ones (M), or unable to be performed (U).

string

Allowed values: P S M U

point

required

Point

string

rationale

required

Rationale

string

room_code

Room Code

string

""

strengths

required

Strengths

string

title

required

Title

string

revision

required

Revision

integer

run_id

Any of:

string

string format: uuid

null

null

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

scenario_summary

required

Scenario Summary

string

status

required

AarStatus

string

Allowed values: draft final

ttx_id

required

Ttx Id

string format: uuid

updated_at

required

Updated At

string format: date-time

version

required

Version

integer

Example

{
  "actions": [
    {
      "status": "open"
    }
  ],
  "can_follow_up": false,
  "can_see_session": false,
  "objectives": [
    {
      "overall": "P",
      "session_ratings": [
        {
          "level": "P",
          "room_code": ""
        }
      ]
    }
  ],
  "runs": [],
  "status": "draft"
}

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"
    }
  ]
}