VMware Pulse IoT Center Rest API development manual Data Structures
- FAILED: Filtered device list creation failed.
- CANCELLED: Filtered device list creation is cancelled because a user deletes the list or the list expires.
- STARTED: Filtered device list creation started and is running.
- FINISHED: Filtered device list creation finished.
- STOPPED_AT_LIMIT: Filtered device list creation stopped because the number of filtered devices exceeds the pre-configured limit.
- DEVICEMGMT_SERVICE: Device management micro service
- CAMPAIGN_SERVICE: LCM micro service
- METRIC_SERVICE: Metric query micro service
Filter message. Filters are always ANDed. A filter consists of a key and multiple operator-value pairs. Only the OR operation is allowed between the operator-value pairs. For example, in '(model = Camry) and (color = red or color = blue)', the 'model' clause and the 'color' clause are AND-ed, while 'color = red' and 'color = blue' are OR-ed.
{
"oredOperationValuePair": [
{
"operator": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}
],
"keyObj": {
"displayUnit": "string",
"displayName": "string",
"valueType": "string",
"dataSource": "string",
"key": "string",
"factor": "number",
"keyQualifier": "string",
"isPeriodRequired": "boolean",
"keyType": "string"
}
}
{
"id": "string",
"name": "string"
}
id
name
{
"keyValuePair": [
{
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"key": "string",
"valueDouble": "number"
}
],
"id": "string"
}
id
{
"displayUnit": "string",
"displayName": "string",
"valueType": "string",
"dataSource": "string",
"key": "string",
"factor": "number",
"keyQualifier": "string",
"isPeriodRequired": "boolean",
"keyType": "string"
}
displayUnit
displayName
key
factor
keyQualifier
isPeriodRequired
{
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"key": "string",
"valueDouble": "number"
}
valueInt64
valueString
valueBoolean
key
valueDouble
{
"operator": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}
valueInt64
valueString
valueBoolean
valueDouble
{
"keyQualifier": "string",
"dataSource": "string",
"key": "string"
}
keyQualifier
key
{
"alertDefId": "string"
}
alertDefId
{
"lastUpdatedTime": "string",
"alertDef": {
"cancelCount": "integer",
"properties": [
"string"
],
"deviceTemplateIds": [
"string"
],
"name": "string",
"lambda": "string",
"triggerCount": "integer",
"alertSeverity": "string",
"isRealTime": "boolean",
"metrics": [
"string"
],
"notificationId": "string",
"deviceId": "string",
"recommendation": "string",
"duration": "integer",
"alertTemplate": "string",
"deviceTemplateId": "string",
"notificationDefinitionId": "string",
"description": "string"
},
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"alertDefId": "string"
}
lastUpdatedTime
lastUpdatedBy
updateVersion
createdBy
createdTime
alertDefId
{
"cancelCount": "integer",
"properties": [
"string"
],
"deviceTemplateIds": [
"string"
],
"name": "string",
"lambda": "string",
"triggerCount": "integer",
"alertSeverity": "string",
"isRealTime": "boolean",
"metrics": [
"string"
],
"notificationId": "string",
"deviceId": "string",
"recommendation": "string",
"duration": "integer",
"alertTemplate": "string",
"deviceTemplateId": "string",
"notificationDefinitionId": "string",
"description": "string"
}
cancelCount
properties
deviceTemplateIds
name
lambda
triggerCount
isRealTime
metrics
notificationId
deviceId
recommendation
duration
deviceTemplateId
notificationDefinitionId
description
{
"alertId": "string"
}
alertId
{
"lastUpdatedTime": "string",
"alertId": "string",
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
],
"alertSeverity": "string",
"state": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"deviceId": "string",
"createdBy": "string",
"createdTime": "string",
"userAcknowledged": "string",
"alertDefId": "string",
"alertDefName": "string"
}
lastUpdatedTime
alertId
lastUpdatedBy
updateVersion
deviceId
createdBy
createdTime
userAcknowledged
alertDefId
alertDefName
{
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
]
}
{
"cancelCount": "integer",
"properties": [
"string"
],
"deviceTemplateIds": [
"string"
],
"name": "string",
"lambda": "string",
"triggerCount": "integer",
"alertSeverity": "string",
"isRealTime": "boolean",
"metrics": [
"string"
],
"notificationId": "string",
"deviceId": "string",
"recommendation": "string",
"duration": "integer",
"alertTemplate": "string",
"deviceTemplateId": "string",
"notificationDefinitionId": "string",
"description": "string"
}
cancelCount
properties
deviceTemplateIds
name
lambda
triggerCount
isRealTime
metrics
notificationId
deviceId
recommendation
duration
deviceTemplateId
notificationDefinitionId
description
{
"alertDefId": "string",
"deviceId": "string",
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
]
}
alertDefId
deviceId
{
"alertDefInfos": [
{
"lastUpdatedTime": "string",
"alertDef": {
"cancelCount": "integer",
"properties": [
"string"
],
"deviceTemplateIds": [
"string"
],
"name": "string",
"lambda": "string",
"triggerCount": "integer",
"alertSeverity": "string",
"isRealTime": "boolean",
"metrics": [
"string"
],
"notificationId": "string",
"deviceId": "string",
"recommendation": "string",
"duration": "integer",
"alertTemplate": "string",
"deviceTemplateId": "string",
"notificationDefinitionId": "string",
"description": "string"
},
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"alertDefId": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"alertInfos": [
{
"lastUpdatedTime": "string",
"alertId": "string",
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
],
"alertSeverity": "string",
"state": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"deviceId": "string",
"createdBy": "string",
"createdTime": "string",
"userAcknowledged": "string",
"alertDefId": "string",
"alertDefName": "string"
}
]
}
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
userName
valueInt64
timeMs
metric
valueBoolean
valueString
valueDouble
{
"cancelCount": "integer",
"properties": [
"string"
],
"deviceTemplateIds": [
"string"
],
"name": "string",
"lambda": "string",
"triggerCount": "integer",
"alertSeverity": "string",
"isRealTime": "boolean",
"metrics": [
"string"
],
"notificationId": "string",
"deviceId": "string",
"recommendation": "string",
"duration": "integer",
"alertTemplate": "string",
"alertDefId": "string",
"deviceTemplateId": "string",
"notificationDefinitionId": "string",
"description": "string"
}
cancelCount
properties
deviceTemplateIds
name
lambda
triggerCount
isRealTime
metrics
notificationId
deviceId
recommendation
duration
alertDefId
deviceTemplateId
notificationDefinitionId
description
{
"state": "string",
"alertId": "string"
}
alertId
{
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
totalPages
totalElements
page
pageSize
{
"supportedApiVersions": [
"string"
],
"currentApiVersion": "string"
}
supportedApiVersions
currentApiVersion
{
"entityType": "string",
"userId": "string",
"auditInformation": "string",
"auditType": "string",
"deviceId": "string",
"createdTime": "string",
"entityId": "string",
"id": "string"
}
entityType
userId
auditInformation
auditType
deviceId
createdTime
entityId
id
{
"ids": [
"string"
]
}
ids
{
"audits": [
{
"entityType": "string",
"userId": "string",
"auditInformation": "string",
"auditType": "string",
"deviceId": "string",
"createdTime": "string",
"entityId": "string",
"id": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"auditTypes": [
"string"
]
}
auditTypes
{
"entityTypes": [
"string"
]
}
entityTypes
{
"userName": "string",
"orgId": "string",
"status": "string",
"displayName": "string",
"permissions": [
"string"
]
}
userName
orgId
status
displayName
permissions
{
"deviceId": "string",
"lastUpdatedTime": "string",
"asRoot": "boolean",
"command": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
],
"createdTime": "string",
"clientId": "string",
"commandId": "string",
"execPath": "string",
"name": "string"
}
deviceId
lastUpdatedTime
asRoot
command
createdTime
clientId
commandId
execPath
name
{
"status": "string",
"name": "string",
"lastUpdatedTime": "string",
"asRoot": "boolean",
"response": "string",
"command": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
],
"createdTime": "string",
"clientId": "string",
"commandId": "string",
"execPath": "string",
"deviceId": "string"
}
status
name
lastUpdatedTime
asRoot
response
command
createdTime
clientId
commandId
execPath
deviceId
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
name
value
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}
name
clientId
command
asRoot
execPath
{
"requestParams": "string",
"id": "string"
}
requestParams
id
{
"credentials": "string"
}
credentials
{
"name": "string",
"value": "string"
}
name
value
{
"name": "string",
"whitelistStatus": "string",
"templateName": "string",
"systemProperties": [
{
"name": "string",
"value": "string"
}
],
"templateId": "string",
"updateVersion": "string",
"createdTime": "string",
"deviceType": "string",
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"parentId": "string",
"enrollmentState": "string",
"orgId": "string",
"id": "string",
"parentGatewayId": "string",
"lastUpdatedTime": "string"
}
name
whitelistStatus
templateName
templateId
updateVersion
createdTime
parentId
orgId
id
parentGatewayId
lastUpdatedTime
{
"parentId": "string",
"name": "string",
"templateName": "string"
}
parentId
name
templateName
{
"name": "string",
"value": "string"
}
name
value
{
"imageDetails": [
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}
],
"name": "string",
"settings": [
{
"category": "string",
"finalSettings": {},
"settings": {}
}
],
"systemProperties": [
{
"name": "string"
}
],
"allowedMetrics": [
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}
],
"updateVersion": "integer",
"enrollmentProvider": {
"providerConfig": "string",
"type": "string"
},
"deviceType": "string",
"allowedCommands": [
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}
],
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"lastUpdatedTime": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"childTemplates": [
"string"
]
}
name
updateVersion
lastUpdatedTime
createdTime
orgId
id
childTemplates
{
"id": "string"
}
id
{
"imageDetails": [
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}
],
"name": "string",
"settings": [
{
"category": "string",
"finalSettings": {},
"settings": {}
}
],
"systemProperties": [
{
"name": "string"
}
],
"allowedMetrics": [
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}
],
"enrollmentProvider": {
"providerConfig": "string",
"type": "string"
},
"deviceType": "string",
"allowedCommands": [
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}
],
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"childTemplates": [
"string"
]
}
name
childTemplates
{
"providerConfig": "string",
"type": "string"
}
providerConfig
type
{
"commandMessage": [
{
"deviceId": "string",
"lastUpdatedTime": "string",
"asRoot": "boolean",
"command": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
],
"createdTime": "string",
"clientId": "string",
"commandId": "string",
"execPath": "string",
"name": "string"
}
]
}
{
"name": "string",
"dataType": "string",
"imageUrl": "string",
"lastUpdatedBy": "string",
"createdBy": "string",
"createdTime": "string",
"data": "string",
"id": "string",
"lastUpdatedTime": "string"
}
name
dataType
imageUrl
lastUpdatedBy
createdBy
createdTime
data
id
lastUpdatedTime
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}
imageUrl
id
sourceType
{
"commandId": "string"
}
commandId
{
"commands": [
{
"status": "string",
"name": "string",
"lastUpdatedTime": "string",
"asRoot": "boolean",
"response": "string",
"command": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
],
"createdTime": "string",
"clientId": "string",
"commandId": "string",
"execPath": "string",
"deviceId": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"devices": [
{
"name": "string",
"whitelistStatus": "string",
"templateName": "string",
"systemProperties": [
{
"name": "string",
"value": "string"
}
],
"templateId": "string",
"updateVersion": "string",
"createdTime": "string",
"deviceType": "string",
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"parentId": "string",
"enrollmentState": "string",
"orgId": "string",
"id": "string",
"parentGatewayId": "string",
"lastUpdatedTime": "string"
}
]
}
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"devices": [
{
"name": "string",
"whitelistStatus": "string",
"templateName": "string",
"systemProperties": [
{
"name": "string",
"value": "string"
}
],
"templateId": "string",
"updateVersion": "string",
"createdTime": "string",
"deviceType": "string",
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"parentId": "string",
"enrollmentState": "string",
"orgId": "string",
"id": "string",
"parentGatewayId": "string",
"lastUpdatedTime": "string"
}
]
}
{
"templates": [
{
"imageDetails": [
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}
],
"name": "string",
"settings": [
{
"category": "string",
"finalSettings": {},
"settings": {}
}
],
"systemProperties": [
{
"name": "string"
}
],
"allowedMetrics": [
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}
],
"updateVersion": "integer",
"enrollmentProvider": {
"providerConfig": "string",
"type": "string"
},
"deviceType": "string",
"allowedCommands": [
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}
],
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"lastUpdatedTime": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"childTemplates": [
"string"
]
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}
timeInterval
displayUnit
displayName
name
factor
batchSize
{
"operator": "string",
"value": "string"
}
value
Property update request.
{
"id": "string",
"remove": [
"string"
],
"upsert": [
{
"name": "string",
"value": "string"
}
]
}
id
remove
{
"category": "string",
"finalSettings": {},
"settings": {}
}
category
{
"name": "string"
}
name
Update agent request.
{
"id": "string"
}
id
{
"commandIds": [
"string"
]
}
commandIds
Update device request.
{
"id": "string",
"name": "string"
}
id
name
{
"imageDetails": [
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}
],
"childTemplates": [
"string"
],
"settings": [
{
"category": "string",
"finalSettings": {},
"settings": {}
}
],
"systemProperties": [
{
"name": "string"
}
],
"allowedMetrics": [
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}
],
"enrollmentProvider": {
"providerConfig": "string",
"type": "string"
},
"allowedCommands": [
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}
],
"customProperties": [
{
"name": "string",
"value": "string"
}
],
"id": "string"
}
childTemplates
id
{
"dataType": "string",
"data": "string",
"name": "string"
}
dataType
data
name
{
"imageUrl": "string",
"id": "string"
}
imageUrl
id
{
"users": [
{
"userName": "string",
"status": "string",
"displayName": "string",
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"createdBy": "string",
"email": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"groups": [
{
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"description": "string"
}
],
"createdTime": "string",
"updateVersion": "integer",
"id": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"userName": "string",
"status": "string",
"displayName": "string",
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"createdBy": "string",
"email": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"groups": [
{
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"description": "string"
}
],
"createdTime": "string",
"updateVersion": "integer",
"id": "string"
}
userName
displayName
lastUpdatedTime
createdBy
lastUpdatedBy
orgId
createdTime
updateVersion
id
{
"name": "string",
"description": "string"
}
name
description
{
"message": "string"
}
message
{
"body": "string",
"senderAlias": "string",
"contentType": "string",
"recipients": [
"string"
],
"sendFrom": "string",
"subject": "string"
}
body
senderAlias
contentType
recipients
sendFrom
subject
{
"msg": "string"
}
msg
{
"lastUpdatedTime": "string",
"name": "string",
"greetingType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string",
"description": "string"
}
lastUpdatedTime
name
lastUpdatedBy
orgId
createdBy
createdTime
Current version of the greeting object.
id
description
{
"id": "string"
}
id
{
"message": "string"
}
message
{
"greetings": [
{
"lastUpdatedTime": "string",
"name": "string",
"greetingType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string",
"description": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"descrpition": "string",
"id": "string"
}
descrpition
id
{
"fullName": "string",
"address": "string",
"id": "string",
"name": "string"
}
fullName
address
id
name
- UNKNOWN: Unknown Assignee Type
- USER: User Assignee Type
- DEVICE: Device Assignee Type
{
"name": "string",
"roles": [
"string"
],
"description": "string"
}
name
roles
description
{
"status": "string",
"name": "string",
"parentId": "string"
}
{
"permissions": [
"integer"
],
"name": "string",
"description": "string"
}
permissions
name
description
{
"createUserRequest": {
"userName": "string",
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"groups": [
"string"
],
"password": "string",
"email": "string"
},
"createOrganizationRequest": {
"status": "string",
"name": "string",
"parentId": "string"
}
}
{
"userName": "string",
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"groups": [
"string"
],
"password": "string",
"email": "string"
}
userName
displayName
roles
groups
password
{
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"description": "string"
}
lastUpdatedTime
name
lastUpdatedBy
updateVersion
createdBy
createdTime
orgId
id
description
{
"id": "string"
}
id
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"groups": [
{
"lastUpdatedTime": "string",
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
],
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"description": "string"
}
]
}
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"members": [
{
"createdBy": "string",
"assignedRoles": [
"string"
],
"assigneeId": "string",
"assigneeType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"assignedGroups": [
"string"
],
"createdTime": "string",
"updateVersion": "string",
"id": "string",
"lastUpdatedTime": "string"
}
]
}
{
"tenants": [
{
"status": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"parentId": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"name": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
]
}
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"roles": [
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
]
}
{
"createdBy": "string",
"assignedRoles": [
"string"
],
"assigneeId": "string",
"assigneeType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"assignedGroups": [
"string"
],
"createdTime": "string",
"updateVersion": "string",
"id": "string",
"lastUpdatedTime": "string"
}
createdBy
assignedRoles
assigneeId
lastUpdatedBy
orgId
assignedGroups
createdTime
updateVersion
id
lastUpdatedTime
{
"status": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"parentId": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"name": "string"
}
lastUpdatedTime
lastUpdatedBy
updateVersion
createdBy
parentId
createdTime
orgId
id
name
{
"id": "string"
}
id
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
permissionNumber
name
description
{
"lastUpdatedTime": "string",
"name": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"createdTime": "string",
"orgId": "string",
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
],
"id": "string",
"description": "string"
}
lastUpdatedTime
name
lastUpdatedBy
updateVersion
createdBy
createdTime
orgId
id
description
{
"id": "string"
}
id
{
"userId": "string",
"orgId": "string"
}
userId
orgId
- UNKNOWN_STATUS: Unkown status
- INACTIVE: Inactive status
- ACTIVE: Active status
- SUSPENDED: Suspended status
{
"accessTokenExpiresAt": "string",
"expiresInSecs": "string",
"refreshToken": "string",
"refreshTokenExpiresAt": "string",
"accessToken": "string"
}
accessTokenExpiresAt
expiresInSecs
refreshToken
refreshTokenExpiresAt
accessToken
{
"description": "string",
"updateVersion": "integer",
"id": "string",
"roles": [
"string"
],
"name": "string"
}
description
updateVersion
id
roles
name
{
"status": "string",
"parentId": "string",
"updateVersion": "integer",
"id": "string",
"name": "string"
}
parentId
updateVersion
id
name
{
"description": "string",
"permissions": [
"integer"
],
"updateVersion": "integer",
"id": "string",
"name": "string"
}
description
permissions
updateVersion
id
name
{
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"email": "string",
"updateVersion": "integer",
"groups": [
"string"
],
"password": "string",
"id": "string"
}
displayName
roles
updateVersion
groups
password
id
{
"id": "string"
}
id
{
"users": [
{
"userName": "string",
"status": "string",
"displayName": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"userName": "string",
"status": "string",
"displayName": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string"
}
userName
status
displayName
lastUpdatedTime
lastUpdatedBy
orgId
createdBy
createdTime
updateVersion
id
{
"id": "string"
}
id
{
"deviceId": "string",
"accessToken": "string"
}
deviceId
accessToken
{
"started": "string",
"timestamp": "string",
"completed": "string",
"errorMessage": "string",
"state": "string",
"error": "boolean"
}
started
timestamp
completed
errorMessage
state
error
{
"status": "string",
"hasApproval": "boolean",
"name": "string",
"creationTime": "string",
"postDeliveryCallback": "string",
"preDeliveryCallback": "string",
"packages": {
"packages": [
"string"
]
},
"approvalNeeded": "boolean",
"id": "string",
"description": "string"
}
status
hasApproval
name
creationTime
postDeliveryCallback
preDeliveryCallback
approvalNeeded
id
description
settings
{
"packagesProgress": [
{
"progress": "string",
"total": "string",
"id": "string"
}
]
}
{
"command": "string",
"commandId": "string",
"arguments": [
"string"
]
}
command
commandId
arguments
{
"gatewayId": "string",
"state": "string",
"closed": "boolean"
}
gatewayId
state
closed
{
"packages": [
"string"
]
}
packages
{
"progress": "string",
"total": "string",
"id": "string"
}
progress
total
id
{
"state": "string"
}
state
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}
timeMs
valueInt64
valueDouble
valueBoolean
valueString
{
"dataPoints": [
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}
],
"metricName": "string"
}
metricName
{
"metricDetails": [
{
"dataPoints": [
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}
],
"metricName": "string"
}
],
"deviceId": "string"
}
deviceId
{
"responseMessage": "string"
}
responseMessage
{
"tsData": [
{
"timeMs": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}
],
"name": "string"
}
name
{
"timeMs": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}
timeMs
valueInt64
valueString
valueBoolean
valueDouble
{
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"key": "string",
"valueString": "string"
}
valueInt64
valueDouble
valueBoolean
key
valueString
{
"httpParameters": {
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
},
"name": "string",
"notificationDestinationId": "string",
"retryCount": "integer",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"description": "string"
}
name
notificationDestinationId
retryCount
description
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"name": "string",
"certificate": "string",
"sslTlsVersion": "string",
"host": "string",
"password": "string",
"port": "integer",
"description": "string"
}
username
name
certificate
host
password
port
description
{
"entityName": "string",
"entityType": "string",
"entityId": "string",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"notificationDefinitionId": "string",
"additionalDetails": [
{
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"key": "string",
"valueString": "string"
}
],
"entityState": "string"
}
entityName
entityType
entityId
notificationDefinitionId
entityState
{
"content": "string",
"endTime": "string",
"startTime": "string",
"title": "string"
}
content
endTime
startTime
title
{
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
}
It consists of a list of email recipients and it is mandatory to have atleast one recipient.
senderEmailAddress
emailSubjectTemplate
emailBodyTemplate
senderName
{
"value": "string",
"key": "string"
}
value
key
{
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
}
relativePath
payloadTemplate
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"notificationDefinitions": [
{
"httpParameters": {
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
},
"description": "string",
"lastUpdatedTime": "string",
"notificationDestinationId": "string",
"updateVersion": "integer",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"notificationDestinationName": "string",
"createdTime": "string",
"retryCount": "integer",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"id": "string",
"name": "string"
}
]
}
notificationDefinitions
{
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
},
"notificationDestinations": [
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"description": "string",
"certificate": "string",
"lastUpdatedTime": "string",
"sslTlsVersion": "string",
"port": "integer",
"host": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string",
"name": "string"
}
]
}
notificationDestinations
{
"notificationInstances": [
{
"status": "string",
"lastUpdatedTime": "string",
"responseStatus": "integer",
"entityName": "string",
"entityType": "string",
"notificationType": "string",
"notificationDefinitionId": "string",
"responseBody": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"emailBody": "string",
"createdBy": "string",
"notificationDefinitionName": "string",
"createdTime": "string",
"updateVersion": "integer",
"entityId": "string",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"emailSubject": "string",
"id": "string",
"additionalDetails": [
{
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"key": "string",
"valueString": "string"
}
],
"entityState": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
{
"systemNotificationInstances": [
{
"status": "string",
"lastUpdatedTime": "string",
"title": "string",
"content": "string",
"lastUpdatedBy": "string",
"createdBy": "string",
"startTime": "string",
"createdTime": "string",
"updateVersion": "integer",
"endTime": "string",
"id": "string"
}
],
"pageInfo": {
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}
}
systemNotificationInstances
{
"httpParameters": {
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
},
"description": "string",
"lastUpdatedTime": "string",
"notificationDestinationId": "string",
"updateVersion": "integer",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"notificationDestinationName": "string",
"createdTime": "string",
"retryCount": "integer",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"id": "string",
"name": "string"
}
description
lastUpdatedTime
notificationDestinationId
updateVersion
lastUpdatedBy
orgId
createdBy
Below properties are populated only for console and are not available as part of normal response.
createdTime
retryCount
id
name
{
"id": "string"
}
id
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"description": "string",
"certificate": "string",
"lastUpdatedTime": "string",
"sslTlsVersion": "string",
"port": "integer",
"host": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string",
"name": "string"
}
username
description
certificate
lastUpdatedTime
port
host
lastUpdatedBy
orgId
createdBy
createdTime
updateVersion
id
name
{
"id": "string"
}
id
{
"status": "string",
"lastUpdatedTime": "string",
"responseStatus": "integer",
"entityName": "string",
"entityType": "string",
"notificationType": "string",
"notificationDefinitionId": "string",
"responseBody": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"emailBody": "string",
"createdBy": "string",
"notificationDefinitionName": "string",
"createdTime": "string",
"updateVersion": "integer",
"entityId": "string",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"emailSubject": "string",
"id": "string",
"additionalDetails": [
{
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"key": "string",
"valueString": "string"
}
],
"entityState": "string"
}
status
lastUpdatedTime
responseStatus
entityName
entityType
notificationType
notificationDefinitionId
responseBody
lastUpdatedBy
orgId
emailBody
createdBy
Below properties are populated only for console and are not available as part of normal response.
createdTime
updateVersion
entityId
emailSubject
id
entityState
{
"id": "string"
}
id
{
"status": "string",
"lastUpdatedTime": "string",
"title": "string",
"content": "string",
"lastUpdatedBy": "string",
"createdBy": "string",
"startTime": "string",
"createdTime": "string",
"updateVersion": "integer",
"endTime": "string",
"id": "string"
}
status
lastUpdatedTime
title
content
lastUpdatedBy
createdBy
startTime
createdTime
updateVersion
endTime
id
{
"id": "string"
}
id
{
"httpParameters": {
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
},
"description": "string",
"notificationDestinationId": "string",
"retryCount": "integer",
"emailParameters": {
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
},
"id": "string",
"name": "string"
}
description
notificationDestinationId
retryCount
id
name
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"description": "string",
"certificate": "string",
"sslTlsVersion": "string",
"port": "integer",
"host": "string",
"password": "string",
"id": "string",
"name": "string"
}
username
description
certificate
port
host
password
id
name
{
"content": "string",
"endTime": "string",
"id": "string",
"startTime": "string",
"title": "string"
}
content
endTime
id
startTime
title
ListValue
is a wrapper around a repeated field of values.
The JSON representation for ListValue
is JSON array.
{
"values": [
"protobufValue Object"
]
}
NullValue
is a singleton enumeration to represent the null value for the Value
type union.
The JSON representation for NullValue
is JSON null
.
- NULL_VALUE: Null value.
Struct
represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct
might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.
The JSON representation for Struct
is JSON object.
Unordered map of dynamically typed values.
Value
represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of that variants, absence of any variant indicates an error.
The JSON representation for Value
is JSON value.
{
"numberValue": "number",
"boolValue": "boolean",
"stringValue": "string",
"structValue": "protobufStruct Object",
"listValue": "protobufListValue Object",
"nullValue": "string"
}
Represents a double value.
Represents a boolean value.
Represents a string value.