Retrieve a Trigger for Service Impacting Events

Retrieve a Trigger for Service Impacting Events - Get Trigger Details

`GET /v2/triggers/{triggerId}`

Retrieving a trigger for Service Impacting Events is similar to updating any trigger in Connectivity Management.The only difference is a few additional values for Service Impacting Events. This page will cover the values Service Impacting Events and provide examples of what requests look like with the new values.

HTTP Request

Retrieve trigger details: GET https://thingspace.verizon.com/api/m2m/v2/triggers/{triggerId}

This query can also be used if the trigger ID isn't known: GET https://thingspace.verizon.com/api/m2m/v2/triggers/categories/ServiceImpactingEvents

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter Name	Data Type	Description
Authorization required	string	HTTP Authorization bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token required	string	A valid session token: `VZ-M2M-Token: {M2Mtoken}`
Content-Type required	string	Must be application/json: `Content-Type: application/json`

Request Parameters

Parameter Name	Data Type	Description
triggerId required	string	This is the system assigned ID of the trigger being retrieved.

Success Responses

Status 200

{    "triggers": [        {            "triggerId": "system generated trigger ID",            "triggerName": "user-defined name of the trigger",            "organizationName": "user-defined group name",            "triggerCategory": "ServiceImpactingEvents",            "serviceImpactingEventsTrigger": {                "filterCriteria": {                    "accountName": "0000123456-00001"                }            },            "notification": {                "notificationType": "PerEvent",                "callback": false,                "emailNotification": false,                "notificationFrequencyFactor": 0,                "smsNotification": false,                "reminder": false,                "severity": "Critical"            },            "active": true,            "createdAt": "2023-06-15T23:49:057.000Z",            "modifiedAt": "2023-06-15T23:52:059.000Z"        }    ]}

Failure Responses

All error messages are returned in this format:

{    "errorCode": "error code string",    "errorMessage": "error message string"}

Response Parameters

Parameter Name	Data Type	Description
triggers	array	Trigger details returned.
triggerId	string	The system assigned ID of the trigger being updated.
triggerName	string	The user defined name of the trigger.
organizationName	string	The user assigned name of the organization associated with the trigger.
triggerCategory	string	The value identifying the type of trigger. This type will always be `ServiceImpactingEvents`.
serviceImpactingEventsTrigger	object	The details of the `ServiceImpactingEvents` trigger.
filterCriteria	object	The filter criteria for application of the trigger.
accountName	string	The Verizon billing account associated with the anomaly triggers for this trigger to be active for devices in those accounts. An account name is usually numeric, and must include any leading zeros.
notification	object	The notification details of the trigger.
notificationType	string	The type of notification must be “PerEvent” for ServiceImpactingEvents.
callback	boolean	Whether or not the notification should be sent via callback. `true` `false`
emailNotification	boolean	Indicates if an email notification will be sent (true) or not (false).
notificationFrequencyFactor	integer	The number of times an email or SMS notification will be sent, including initial notification.
smsNotification	boolean	Indicates if an SMS notification will be sent (true) or not (false).
reminder	boolean	Indicates if a daily reminder will be sent (true) or not (false) in addition to notification.
severity	string	Severity level associated with the notification. Examples would be: `Major` `Minor` `Critical` `NotApplicable`
active	boolean	Shows if a trigger is active (true) or inactive (false).
createdAt	string (date-time)	Timestamp for when the trigger was created.
modifiedAt	string (date-time)	Timestamp for the most recent time the trigger was modified.

# Retrieve a Trigger for Service Impacting Events - Get Trigger Details ### `GET /v2/triggers/{triggerId}` Retrieving a trigger for Service Impacting Events is similar to updating any trigger in Connectivity Management.The only difference is a few additional values for Service Impacting Events. This page will cover the values Service Impacting Events and provide examples of what requests look like with the new values. ## HTTP Request Retrieve trigger details: GET [https://thingspace.verizon.com/api/m2m/v2/triggers/{triggerId}](/docs/premium-apis/thingspace-intelligence/api-endpoints/anomaly-triggers-v2/listanomalydetectiontriggersettingsv2) This query can also be used if the trigger ID isn't known: GET <https://thingspace.verizon.com/api/m2m/v2/triggers/categories/ServiceImpactingEvents> ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |:-----------------------|:-----------|:-----------------------------------------------------------------------------| | **Authorization** _required_ | string | HTTP Authorization bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** _required_ | string | A valid session token: `VZ-M2M-Token: {M2Mtoken}` | | **Content-Type** _required_ | string | Must be application/json: `Content-Type: application/json` | ## Request Parameters | Parameter Name | Data Type | Description | |:-------------------|:---------|:--------------------------------------------------------------| | **triggerId** _required_ | string | This is the system assigned ID of the trigger being retrieved. | ## Success Responses Status 200 ``` json { "triggers": [ { "triggerId": "system generated trigger ID", "triggerName": "user-defined name of the trigger", "organizationName": "user-defined group name", "triggerCategory": "ServiceImpactingEvents", "serviceImpactingEventsTrigger": { "filterCriteria": { "accountName": "0000123456-00001" } }, "notification": { "notificationType": "PerEvent", "callback": false, "emailNotification": false, "notificationFrequencyFactor": 0, "smsNotification": false, "reminder": false, "severity": "Critical" }, "active": true, "createdAt": "2023-06-15T23:49:057.000Z", "modifiedAt": "2023-06-15T23:52:059.000Z" } ] } ``` ## Failure Responses All error messages are returned in this format: ``` json { "errorCode": "error code string", "errorMessage": "error message string" } ``` ## Response Parameters | Parameter Name | Data Type | Description | |:------------------------------------|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **triggers** | array | Trigger details returned. | |&emsp;**triggerId** | string | The system assigned ID of the trigger being updated. | |&emsp;**triggerName** | string | The user defined name of the trigger. | |&emsp;**organizationName** | string | The user assigned name of the organization associated with the trigger. | |&emsp;**triggerCategory** | string | The value identifying the type of trigger. This type will always be `ServiceImpactingEvents`. | | &emsp;**serviceImpactingEventsTrigger** | object | The details of the ``ServiceImpactingEvents`` trigger. | |&emsp;&emsp;**filterCriteria** | object | The filter criteria for application of the trigger. | |&emsp;&emsp;&emsp;**accountName** | string | The Verizon billing account associated with the anomaly triggers for this trigger to be active for devices in those accounts. An account name is usually numeric, and must include any leading zeros. | |&emsp;**notification** | object | The notification details of the trigger. | |&emsp;&emsp;**notificationType** | string | The type of notification must be “PerEvent” for ServiceImpactingEvents. | |&emsp;&emsp;**callback** | boolean | Whether or not the notification should be sent via callback. <ul><li> `true` </li><li> `false` </li></ul> | |&emsp;&emsp;**emailNotification** | boolean | Indicates if an email notification will be sent (true) or not (false). | |&emsp;&emsp;**notificationFrequencyFactor** | integer | The number of times an email or SMS notification will be sent, including initial notification. | |&emsp;&emsp;**smsNotification** | boolean | Indicates if an SMS notification will be sent (true) or not (false). | |&emsp;&emsp;**reminder** | boolean | Indicates if a daily reminder will be sent (true) or not (false) in addition to notification. | |&emsp;&emsp;**severity** | string | Severity level associated with the notification. Examples would be: <ul><li>`Major` </li><li> `Minor` </li><li> `Critical` </li><li> `NotApplicable` </li></ul> | |&emsp;**active** | boolean | Shows if a trigger is active (true) or inactive (false). | |&emsp;**createdAt** | string (date-time) | Timestamp for when the trigger was created. | |&emsp;**modifiedAt** | string (date-time) | Timestamp for the most recent time the trigger was modified. |

Verizon 5G Edge API Portal

Retrieve a Trigger for Service Impacting Events