← All message topics  ·  schema GroundTruth/VictimList/victimlist_groundtruth_message.json

header

FieldTypeRequiredAllowed valuesDescription
timestamp string
message_type string groundtruth
version string The message format version

msg

FieldTypeRequiredAllowed valuesDescription
experiment_id string
trial_id string
timestamp string
source string
sub_type string Mission:VictimList
version string
replay_parent_type string|null TRIAL REPLAY null
replay_parent_id string|null
replay_id string|null

data

FieldTypeRequiredAllowed valuesDescription
mission_timer string
mission string
mission_victim_list array<object>
mission_victim_list[].x number
mission_victim_list[].y number
mission_victim_list[].z number
mission_victim_list[].block_type string
mission_victim_list[].room_name string
mission_victim_list[].unique_id number

Example message

{
	"header": {
		"timestamp": "2019-12-26T12:47:23.1234Z",
		"message_type": "groundtruth",
		"version": "0.6"
	},
	"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": "Mission:VictimList",
		"version": "0.6"
	},
	"data": {
		"mission_timer":"Not Initialized",
		"mission": "SaturnA",	
		"mission_victim_list" : [ {
			"x" : -2088.0,
			"y" : 60.0,
			"z" : 146.0,
			"block_type" : "block_victim_1",
			"room_name" : "Security Office",
			"unique_id" : 1
		}, {
			"x" : -2087.0,
			"y" : 60.0,
			"z" : 146.0,
			"block_type" : "block_victim_2",
			"room_name" : "Security Office",
			"unique_id" : 2
		}, {
			"x" : -2086.0,
			"y" : 60.0,
			"z" : 146.0,
			"block_type" : "block_victim_saved",
			"room_name" : "Security Office",
			"unique_id" : 3
		} ]			
	}
}
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": {
        "mission": {
          "$id": "#/properties/data/properties/mission",
          "examples": [
            "Singleplayer",
            "Multiplayer"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Name Schema",
          "type": "string"
        },
        "mission_timer": {
          "$id": "#/properties/event/state/mission_timer",
          "examples": [
            "8 : 36"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Timer Schema",
          "type": "string"
        },
        "mission_victim_list": {
          "$id": "#/properties/data/properties/mission_victim_list",
          "default": "",
          "examples": [
            "[ {\"x\" : -2088.0,\"y\" : 60.0,\"z\" : 146.0,\"block_type\" : \"block_victim_1\",\"roomName\" : \"Security Office\"}]"
          ],
          "items": {
            "$id": "http://asist.aptima.com/schemas/mission_victim.json",
            "$schema": "http://json-schema.org/draft-07/schema#",
            "definitions": {},
            "properties": {
              "block_type": {
                "$id": "#/properties/block_type",
                "examples": [
                  "block_victim_1",
                  "block_victim_proximity",
                  "block_victim_saved"
                ],
                "pattern": "^(.*)$",
                "title": "The Block Type Schema",
                "type": "string"
              },
              "room_name": {
                "$id": "#/properties/room_name",
                "examples": [
                  "Security Office"
                ],
                "pattern": "^(.*)$",
                "title": "The Room Name Schema",
                "type": "string"
              },
              "unique_id": {
                "$id": "#/properties/uniaue_id",
                "examples": [
                  1,
                  33,
                  55
                ],
                "pattern": "^([0-9]+?)$",
                "title": "The unique Victim Id Schema",
                "type": "number"
              },
              "x": {
                "$id": "#/properties/x",
                "default": 0,
                "examples": [
                  -2194
                ],
                "title": "The X Schema",
                "type": "number"
              },
              "y": {
                "$id": "#/properties/y",
                "default": 0,
                "examples": [
                  24
                ],
                "title": "The Y Schema",
                "type": "number"
              },
              "z": {
                "$id": "#/properties/z",
                "default": 0,
                "examples": [
                  190
                ],
                "title": "The Z Schema",
                "type": "number"
              }
            },
            "required": [
              "x",
              "y",
              "z",
              "block_type",
              "unique_id"
            ],
            "title": "Misson Victim Schema",
            "type": "object",
            "version": "0.6"
          },
          "title": "The Victim List Schema",
          "type": "array"
        }
      },
      "required": [
        "mission_timer",
        "mission",
        "mission_victim_list"
      ],
      "title": "The GroundTruth Mission:VictimList 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": "groundtruth",
          "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": "Mission:VictimList",
          "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 GroundTruth Mission:VictimList Schema",
  "type": "object",
  "version": "0.5"
}
Upstream spec documentation

GroundTruth Subtype:Mission:VictimList Message Format

This GroundTruth message subtype is used to communicate the victim list.

TOPIC

ground_truth/mission/victims_list

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.mission string The name of the mission in progress
data.mission_victim_list List of mission_victim the list of victims in the mission

Message Example

{
    "header": {
        "timestamp": "2019-12-26T12:47:23.1234Z",
        "message_type": "groundtruth",
        "version": "0.6"
    },
    "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": "Mission:VictimList",
        "version": "0.6"
    },
    "data": {
        "mission_timer":"Not Initialized",
        "mission": "SaturnA",   
        "mission_victim_list" : [ {
            "x" : -2088.0,
            "y" : 60.0,
            "z" : 146.0,
            "block_type" : "block_victim_1",
            "room_name" : "Security Office",
            "unique_id" : 1
        }, {
            "x" : -2087.0,
            "y" : 60.0,
            "z" : 146.0,
            "block_type" : "block_victim_2",
            "room_name" : "Security Office",
            "unique_id" : 2
        }, {
            "x" : -2086.0,
            "y" : 60.0,
            "z" : 146.0,
            "block_type" : "block_victim_saved",
            "room_name" : "Security Office",
            "unique_id" : 3
        } ]         
    }
}

CHANGE HISTORY

VERSION | DATE | DETAILS | --- | --- | --- | | 0.6 | 4/27/2021 | Included a victim_id for each victim. Changed all numbers to integers | | 0.5 | NA | Initial Creation |