Texecom Event Schemas

JSON Schema Documentation

walk test initiated paylaod

Emitted when a walk test is started, either from the app, panel, or another system actor.

$idhttps://schemas.texecom-prod.com/v2/events/payload/walk_test/start/initiated/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
panelIdString
walkTestIdString
initiatedByString

panelId

Description UUID that will give would be identification for panel
TypeString
Required Yes
Format uuid

walkTestId

Description walk test UUID for particular walk test
TypeString
Required Yes
Format uuid

initiatedBy

Description display the name of the initiator
TypeString
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/walk_test/start/initiated/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "walk test initiated paylaod",
    "description": "Emitted when a walk test is started, either from the app, panel, or another system actor.",
    "type": "object",
    "properties": {
        "panelId": {
            "description": "UUID that will give would be identification for panel",
            "type": "string",
            "format": "uuid"
        },
        "walkTestId": {
            "description": "walk test UUID for particular walk test",
            "type": "string",
            "format": "uuid"
        },
        "initiatedBy": {
            "description": "display the name of the initiator",
            "type": "string"
        }
    },
    "required": [
        "panelId",
        "walkTestId",
        "initiatedBy"
    ],
    "additionalProperties": false
}