← All message topics · schema TrainingTask/trainingtask_event_message.json

header

Field	Type	Required	Allowed values	Description
timestamp	string	✓
message_type	string	✓	`event`
version	string	✓		The message format version

msg

Field	Type	Required	Allowed values
experiment_id	string	✓
trial_id	string
timestamp	string	✓
source	string	✓
sub_type	string	✓	`Event:TrainingTask`
version	string	✓
replay_parent_type	string\|null		`TRIAL` `REPLAY` `null`
replay_parent_id	string\|null
replay_id	string\|null

data

Field	Type	Required	Allowed values
mission_timer	string
elapsed_milliseconds	number
participant_id	string	✓
callsign	string	✓
playername	string
task_message	string	✓	`Red Training: Start` `Red Training: Task #1 Complete` `Red Training: Task #2 Complete` `Red Training: Task #3 Complete` `Red Training: Task #4 Complete` `Red Training: End` `Red Team Training: Start` `Red Team Training: End` `Green Training: Start` `Green Training: Task #1 Complete` `Green Training: Task #2 Complete` `Green Training: Task #3 Complete` `Green Training: Task #4 Complete` `Green Training: End` `Green Team Training: Start` `Green Team Training: End` `Blue Training: Start` `Blue Training: Task #1 Complete` `Blue Training: Task #2 Complete` `Blue Training: Task #3 Complete` `Blue Training: Task #4 Complete` `Blue Training: End` `Blue Team Training: Start` `Blue Team Training: End`

Example message

{
	"header": {
		"timestamp": "2019-12-26T12:47:23.1234Z",
		"message_type": "event",
		"version": "1"
	},
	"msg": { 
		"experiment_id": "563e4567-e89b-12d3-a456-426655440000",
		"trial_id": "123e4567-e89b-12d3-a456-426655440000",
		"timestamp": "2019-12-26T14:05:02.1412Z",
		"source": "simulator",
		"sub_type": "Event:TrainingTask",
		"version": "2.0"
	},
	"data": {
	    "mission_timer":"8 : 36",
		"elapsed_milliseconds": 15113,
		"playerName": "Player682",
		"participant_id": "P101",
		"callSign": "Green",
		"task_message": "Green Training: Task #1 Complete"
  }
}

Raw JSON Schema (resolved)

{
  "$id": "http://asist.aptima.com/schemas/event_state.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "#/properties/message/properties/data",
      "properties": {
        "callsign": {
          "$id": "#/properties/data/properties/participant_id",
          "examples": [
            "E000321"
          ],
          "pattern": "^(.*)$",
          "title": "The Participant id Schema",
          "type": "string"
        },
        "elapsed_milliseconds": {
          "$id": "#/properties/data/properties/elapsed_milliseconds",
          "examples": [
            5000,
            77459,
            689457
          ],
          "pattern": "^[0-9]+$",
          "title": "The Elapsed Milliseconds Schema",
          "type": "number"
        },
        "mission_timer": {
          "$id": "#/properties/data/properties/mission_timer",
          "examples": [
            "8 : 36"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Timer Schema",
          "type": "string"
        },
        "participant_id": {
          "$id": "#/properties/data/properties/participant_id",
          "examples": [
            "E000321"
          ],
          "pattern": "^(.*)$",
          "title": "The Participant id Schema",
          "type": "string"
        },
        "playername": {
          "$id": "#/properties/data/properties/playername",
          "examples": [
            "Aptiminer1"
          ],
          "pattern": "^(.*)$",
          "title": "The Playername Schema",
          "type": "string"
        },
        "task_message": {
          "$id": "#/properties/data/properties/task_message",
          "enum": [
            "Red Training: Start",
            "Red Training: Task #1 Complete",
            "Red Training: Task #2 Complete",
            "Red Training: Task #3 Complete",
            "Red Training: Task #4 Complete",
            "Red Training: End",
            "Red Team Training: Start",
            "Red Team Training: End",
            "Green Training: Start",
            "Green Training: Task #1 Complete",
            "Green Training: Task #2 Complete",
            "Green Training: Task #3 Complete",
            "Green Training: Task #4 Complete",
            "Green Training: End",
            "Green Team Training: Start",
            "Green Team Training: End",
            "Blue Training: Start",
            "Blue Training: Task #1 Complete",
            "Blue Training: Task #2 Complete",
            "Blue Training: Task #3 Complete",
            "Blue Training: Task #4 Complete",
            "Blue Training: End",
            "Blue Team Training: Start",
            "Blue Team Training: End"
          ],
          "examples": [
            "Red Training: Start",
            "Green Training: Task #1 Complete",
            "Blue Training: Task #4 Complete"
          ],
          "pattern": "^(.*)$",
          "title": "The Task Message Schema",
          "type": "string"
        }
      },
      "required": [
        "participant_id",
        "callsign",
        "task_message"
      ],
      "title": "The Training Task Data Schema",
      "type": "object"
    },
    "header": {
      "$id": "http://asist.aptima.com/schemas/common_header.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "message_type": {
          "$id": "#/properties/message_type",
          "const": "event",
          "enum": [
            "control",
            "observation",
            "chat",
            "status",
            "trial",
            "event",
            "groundtruth",
            "experiment",
            "metadata",
            "agent"
          ],
          "examples": [
            "observation"
          ],
          "pattern": "^([a-z_]*?)$",
          "title": "The Message_type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "examples": [
            "2019-12-26T12:47:23.1234Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "examples": [
            "1.0",
            "2.3.1"
          ],
          "pattern": "^([0-9]+\\.)?([0-9]+\\.)?([0-9]+)$",
          "title": "The message format version",
          "type": "string"
        }
      },
      "required": [
        "timestamp",
        "message_type",
        "version"
      ],
      "title": "ASIST message common header Schema",
      "type": "object",
      "version": "0.3"
    },
    "msg": {
      "$id": "http://asist.aptima.com/schemas/event_message.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "experiment_id": {
          "$id": "#/properties/experiment_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|Null|null)",
          "title": "The Experiment Id Schema",
          "type": "string"
        },
        "replay_id": {
          "$id": "#/properties/replay_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_id": {
          "$id": "#/properties/replay_parent_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Parent Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_type": {
          "$id": "#/properties/replay_parent_type",
          "enum": [
            "TRIAL",
            "REPLAY",
            null
          ],
          "title": "The Replay Parent Type Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$id": "#/properties/source",
          "default": "",
          "examples": [
            "simulator"
          ],
          "pattern": "^(.*)$",
          "title": "The Source Schema",
          "type": "string"
        },
        "sub_type": {
          "$id": "#/properties/sub_type",
          "const": "Event:TrainingTask",
          "default": "",
          "examples": [
            "equip",
            "triage"
          ],
          "pattern": "^([a-zA-Z0-9_:]*?)$",
          "title": "The Sub Type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "default": "",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "trial_id": {
          "$id": "#/properties/trial_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Trial Id Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "default": "",
          "examples": [
            "0.1",
            "1.0.1"
          ],
          "pattern": "^([.]*)|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
          "title": "The Version Schema",
          "type": "string"
        }
      },
      "required": [
        "experiment_id",
        "timestamp",
        "source",
        "sub_type",
        "version"
      ],
      "title": "The Event Message Schema",
      "type": "object",
      "version": "0.5"
    }
  },
  "required": [
    "header",
    "msg",
    "data"
  ],
  "title": "The Training Task Event Schema",
  "type": "object",
  "version": "2.0"
}

Upstream spec documentation

Data Subtype: Event Message Format

This data message subtype is used to communicate event data for both the world and the player.

TOPIC

observations/events/training/task

Message Fields

Field Name	Type	Description
header	object	From Common Header Format section
msg	object	From the Common Event Message Format section
data.mission_timer	string	the mission time of the event
data.elapsed_milliseconds	number	the number of elapsed milliseconds since mission start
data.participant_id	string	the participant id for the player being reported
data.callsign	string	the callsign of the player being reported
data.playername	string	[Deprecated]The name of the entity that changed state
task_message	string	The message indicating the competency task status

Message Example

{
    "header": {
        "timestamp": "2019-12-26T12:47:23.1234Z",
        "message_type": "event",
        "version": "1"
    },
    "msg": { 
        "experiment_id": "563e4567-e89b-12d3-a456-426655440000",
        "trial_id": "123e4567-e89b-12d3-a456-426655440000",
        "timestamp": "2019-12-26T14:05:02.1412Z",
        "source": "simulator",
        "sub_type": "Event:TrainingTask",
        "version": "2.0"
    },
    "data": {
        "mission_timer":"8 : 36",
        "elapsed_milliseconds": 15113,
        "playerName": "Player682",
        "participant_id": "P101",
        "callSign": "Green",
        "task_message": "Green Training: Task #1 Complete"
  }
}

CHANGE HISTORY

VERSION | DATE | DETAILS | --- | --- | --- | 2.0 | 1/17/2021 | Initial Schema Creation