Specialized APIsSensor InsightsAPI Reference
Retrieve a rule
POST /dm/v1/rules/actions/query
Use this endpoint to retrieve an existing rule record used for a Smart Alert.
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 request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
HTTP Request
POST https://thingspace.verizon.com/api/dm/v1/rules/actions/query
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| accountname | string | The numeric name of the account and must include leading zeros. |
| filter | object | Optional filter data to narrow the search. |
| $expand (optional) | string | Use to provide device details to filter on. |
| $limitnumber (optional) | integer | Limits the number of results returned. |
| $nopagination (optional) | boolean | A flag to indicate if pagination is requested ( false ) or not ( true ). |
| $page (optional) | string | The number of pages in the response. |
| $pagenumber (optional) | integer | The page number requested (if known). |
| $projection (optional) | array | Limits results to the fields of the device that the user is interested in rather than all of the fields. |
| $selection (optional) | object | Filters results based on user defined criteria. |
| resourceidentifier | object | The resource ID values. |
| id | string | The UUID of the resource. A UUID is a 34 or 36-bit alphanumeric value. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"filter": {
"$expand": "device detail(s)",
"$limitnumber": 100,
"$nopagination": true,
"$page": "The number of pages",
"$pagenumber": 100,
"$projection": [
"details requested"
],
"$selection": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"resourceidentifier": {
"id": "ffb86390-eeee-ffff-gggg-9d1180882d63"
}
}Success Response
Status 200 This is a synchronous response, so the rule record will be returned. Example Response:
{
"accountclientid": null,
"billingaccountid": "0000123456-00001",
"createdon": "2023-10-02T15:46:34.562Z",
"description": "a short description",
"deviceid": "The UUID of the device",
"disabled": false,
"foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",
"id": "UUID of the resource",
"lastupdated": "2023-10-02T15:46:34.562Z",
"name": "name of the record",
"rulechain": {},
"rulesyntax": "The rule syntax",
"version": "1.0",
"versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395"
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountclientid | string | Future functionality. This value will be "null". |
| billingaccountid | string | The numeric name of the account and must include leading zeros. This value matches the accountname. |
| createdon | string ($date-time) | The timestamp of when the record was created. |
| description | string | A short description of the rule. |
| deviceid | string | The UUID of the device. This value is assigned when the device is onboarded. |
| disabled | boolean | A flag indicating if the rule is disabled ( true ) or not ( false ). |
| foreignid | string | The UUID value of the user's Enterprise Customer Profile Database (ECPD) account. A UUID is a 32 to 36-bit alphanumeric string. |
| id | string | The UUID of the resource record. A UUID is a 32 to 36-bit alphanumeric string. |
| lastupdated | string ($date-time) | The timestamp of when the last update to the record was made. |
| name | string | The user defined name of the record. |
| rulechain | object | The sequence of events triggering an alert. |
| rulesyntax | string | The syntax of the rule and can support camel and json style syntaxes. |
| version | string | The resource version. |
| versionid | string | The UUID of the resource version. A UUID is a 32 to 36-bit alphanumeric string. |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}