Specialized APIsSensor InsightsAPI Reference
Query a device profile
Query an Individual Device Profile
POST /dm/v1/deviceConfigurationProfiles/actions/query
Use this endpoint to query an individual device profile.
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/deviceConfigurationProfiles/actions/query
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| filter | object | The values to filter on to select the device profile to view. |
| $selection | object | An object containing the model ID of the device profile. |
| modelid | string | The UUID of the sensor's model identifier. A UUID is a 32 to 36-bit alphanumeric string. This value is assigned at onboarding. |
| $querytotalcount | boolean | A flag to retrieve either all profiles ( true ) or just the first listed ( false ). |
Request Body
Example Request:
{
"filter": {
"$selection": {
"modelid": "00000000-0000-0000-0000-000000000019"
},
"$querytotalcount": true
}
}Success Response
Status 201 This is a synchronous response, so the details of the device profile will be returned. Example Response:
[
{
"id": "cb4169ec-eeee-ffff-gggg-d2951060421a",
"kind": "the kind of profile being created",
"version": "1.0",
"versionid": "15bd78a1-eeee-ffff-gggg-86daa842009b",
"createdon": "2023-10-02T15:46:34.562Z",
"lastupdated": "2023-10-02T15:46:34.562Z",
"name": "Demo Entry sensor 1730928792",
"foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",
"billingaccountid": "0000123456-00001",
"modelid": "00000000-0000-0000-0000-000000000019",
"configuration": {
"randomInt": 21,
"resportingInterval": 24
}
}
]Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| id | string | The UUID of the request. A UUID is a 32 to 36-bit alphanumeric string. |
| kind | string | The kind of profile created, as per the user. |
| version | string | the version of the device profile. |
| versionid | string | The UUID of the version. A UUID is a 32 to 36-bit alphanumeric string. |
| createdon | string ($date-time) | The timestamp of when the record was created. |
| lastupdated | string ($date-time) | The timestamp of when the last update to the record was made. |
| name | string | The user-assigned name of the sensor. |
| 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. |
| billingaccountid | string | The numeric name of the account and must include leading zeros. This value matches the accountname. |
| modelid | string | The UUID of the sensor's model identifier. A UUID is a 32 to 36-bit alphanumeric string. This value is assigned at onboarding. |
| configuration | object | The time intervals for the sensor to report data as a default. |
| randomInt | integer | The reporting interval (in hours) if an event is detected. |
| reportingInterval | integer | The reporting interval (in hours) as a default. |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}