Texecom Event Schemas

JSON Schema Documentation

walk test status read payload

Records a status query against a walk test, returning its current lifecycle state.

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

Properties

NameType
panelIdString
walkTestIdString
statusString

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

status

Description current walk test status
TypeString
Required Yes
Enum
  • idle
  • in_progress
  • completed

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/walk_test/status/read/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "walk test status read payload",
    "description": "Records a status query against a walk test, returning its current lifecycle state.",
    "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"
        },
        "status": {
            "description": "current walk test status",
            "type": "string",
            "enum": [
                "idle",
                "in_progress",
                "completed"
            ]
        }
    },
    "required": [
        "panelId",
        "walkTestId",
        "status"
    ],
    "additionalProperties": false
}