Common Properties for ARC response events

Common properties shared across multiple ARC received event types.

$id	https://schemas.texecom-prod.com/v2/events/event-type/arc/common/received/v1.0.0.json
$schema	http://json-schema.org/draft-07/schema

Properties

Name		Type
panelId		Number
arcId		String
arcName		String
arcEndpoint		String
monitorEventId		Number
monitorEventActionId		Number
details		String
sentPayload		String
error		String
status		Number
sentTime		String
receivedTime		String
flightTime		Number
monitorRuleId		Number

---

panelId

Description	The id of the site that triggered this event
Type	Number
Required	Yes

arcId

Description	The unique id of the ARC
Type	String
Required	Yes

arcName

Description	The name of the ARC
Type	String
Required	Yes

arcEndpoint

Description	The configured endpoint of the ARC
Type	String
Required	No

monitorEventId

Description	The id of the event that triggered this action
Type	Number
Required	Yes

monitorEventActionId

Description	The id of the action that triggered this event
Type	Number
Required	Yes

details

Description	Details of what was done, depends on the action
Type	String
Required	No

sentPayload

Description	The payload content sent to the ARC
Type	String
Required	No

error

Description	Error message (if there was an error)
Type	String
Required	No

status

Description	Indicates the action status 0=success, 1 and above is an error code
Type	Number
Required	Yes

sentTime

Description	Timestamp that the message was sent to the server
Type	String
Required	Yes
Format	date-time

receivedTime

Description	Timestamp that the message was received by the server
Type	String
Required	No
Format	date-time

flightTime

Description	The message flight time in milliseconds (essentially received timestamp in millseconds minus sent timestamp in milliseconds)
Type	Number
Required	No

monitorRuleId

Description	The id of the rule that triggered this event
Type	Number
Required	Yes

---

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/event-type/arc/common/received/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Common Properties for ARC response events",
    "description": "Common properties shared across multiple ARC received event types.",
    "type": "object",
    "properties": {
        "panelId": {
            "type": "number",
            "description": "The id of the site that triggered this event"
        },
        "arcId": {
            "type": "string",
            "description": "The unique id of the ARC"
        },
        "arcName": {
            "type": "string",
            "description": "The name of the ARC"
        },
        "arcEndpoint": {
            "type": "string",
            "description": "The configured endpoint of the ARC"
        },
        "monitorEventId": {
            "type": "number",
            "description": "The id of the event that triggered this action"
        },
        "monitorEventActionId": {
            "type": "number",
            "description": "The id of the action that triggered this event"
        },
        "details": {
            "type": "string",
            "description": "Details of what was done, depends on the action"
        },
        "sentPayload": {
            "type": "string",
            "description": "The payload content sent to the ARC"
        },
        "error": {
            "type": "string",
            "description": "Error message (if there was an error)"
        },
        "status": {
            "type": "number",
            "description": "Indicates the action status 0=success, 1 and above is an error code"
        },
        "sentTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp that the message was sent to the server"
        },
        "receivedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp that the message was received by the server"
        },
        "flightTime": {
            "type": "number",
            "description": "The message flight time in milliseconds (essentially received timestamp in millseconds minus sent timestamp in milliseconds)"
        },
        "monitorRuleId": {
            "type": "number",
            "description": "The id of the rule that triggered this event"
        }
    },
    "additionalProperties": false,
    "required": [
        "panelId",
        "arcId",
        "arcName",
        "arcEndPoint",
        "monitorEventId",
        "monitorEventActionId",
        "status",
        "sentTime",
        "monitorRuleId"
    ]
}