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
protocol		String
arcId		String
arcName		String
arcEndPoint		String
monitorEventId		Number
monitorEventActionId		Number
monitorEventActionDetails		String
monitorEventActionStatus		Number
monitorEventActionSentTime		String
monitorEventActionReceivedTime		String
monitorEventActionFlightTime		Number
monitorEventActionAckPending		Boolean
monitorEventActionAcknowledged		Number
lastUpdatedTime		String
monitorEventActionSentTimeMs		Number
monitorEventActionReceivedTimeMs		Number
monitorRuleId		Number
monitorRuleAction		Number

---

protocol

Type	String
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	Yes

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

monitorEventActionDetails

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

monitorEventActionStatus

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

monitorEventActionSentTime

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

monitorEventActionReceivedTime

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

monitorEventActionFlightTime

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

monitorEventActionAckPending

Description	Indicates if the action has been acknowledged by the server
Type	Boolean
Required	Yes

monitorEventActionAcknowledged

Description	Timestamp that the user acknowledged the event (if applicable)
Type	Number
Required	Yes

lastUpdatedTime

Type	String
Required	Yes
Format	date-time

monitorEventActionSentTimeMs

Description	Timestamp that the message was sent to the server in milliseconds
Type	Number
Required	Yes

monitorEventActionReceivedTimeMs

Description	Timestamp that the message was received by the server in milliseconds
Type	Number
Required	Yes

monitorRuleId

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

monitorRuleAction

Description	The action, see /api/phoenix/rules/actions in texecom-cloud repo
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": {
        "protocol": {
            "type": "string"
        },
        "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"
        },
        "monitorEventActionDetails": {
            "type": "string",
            "description": "Details of what was done, depends on the action"
        },
        "monitorEventActionStatus": {
            "type": "number",
            "description": "Indicates the action status 0=success, 1 and above is an error code"
        },
        "monitorEventActionSentTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp that the message was sent to the server"
        },
        "monitorEventActionReceivedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp that the message was received by the server"
        },
        "monitorEventActionFlightTime": {
            "type": "number",
            "description": "The message flight time in milliseconds (essentially received timestamp in millseconds minus sent timestamp in milliseconds)"
        },
        "monitorEventActionAckPending": {
            "type": "boolean",
            "description": "Indicates if the action has been acknowledged by the server"
        },
        "monitorEventActionAcknowledged": {
            "type": "number",
            "description": "Timestamp that the user acknowledged the event (if applicable)"
        },
        "lastUpdatedTime": {
            "type": "string",
            "format": "date-time"
        },
        "monitorEventActionSentTimeMs": {
            "type": "number",
            "description": "Timestamp that the message was sent to the server in milliseconds"
        },
        "monitorEventActionReceivedTimeMs": {
            "type": "number",
            "description": "Timestamp that the message was received by the server in milliseconds"
        },
        "monitorRuleId": {
            "type": "number",
            "description": "The id of the rule that triggered this event"
        },
        "monitorRuleAction": {
            "type": "number",
            "description": "The action, see /api/phoenix/rules/actions in texecom-cloud repo"
        }
    },
    "additionalProperties": false,
    "required": [
        "protocol",
        "arcId",
        "arcName",
        "arcEndPoint",
        "monitorEventId",
        "monitorEventActionId",
        "monitorEventActionDetails",
        "monitorEventActionStatus",
        "monitorEventActionSentTime",
        "monitorEventActionReceivedTime",
        "monitorEventActionFlightTime",
        "monitorEventActionAckPending",
        "monitorEventActionAcknowledged",
        "monitorEventActionSentTimeMs",
        "monitorEventActionReceivedTimeMs",
        "monitorRuleId",
        "monitorRuleAction",
        "lastUpdatedTime"
    ]
}