VMware Pulse IoT Center Rest API development manual Data Structures
KeyObjKeyType
This data structure has no properties.
Enumeration: UNKNOWN_KEY_TYPE, PROJECTABLE, FILTERABLE, BOTH,
OredOperatorValuePairOperator
This data structure has no properties.
Enumeration: UNKNOWN_OPERATOR, EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, GREATER_THAN_EQUAL_TO, LESS_THAN, LESS_THAN_EQUAL_TO, CONTAINS,
aggregatorAggregationTaskStatus
- 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.
This data structure has no properties.
Enumeration: UNKNOWN_AGGREGATION_TASK_STATUS, FAILED, CANCELLED, STARTED, FINISHED, STOPPED_AT_LIMIT,
aggregatorDataSource
- DEVICEMGMT_SERVICE: Device management micro service
- CAMPAIGN_SERVICE: LCM micro service
- METRIC_SERVICE: Metric query micro service
This data structure has no properties.
Enumeration: UNKNOWN_DATA_SOURCE, DEVICEMGMT_SERVICE, CAMPAIGN_SERVICE, METRIC_SERVICE,
aggregatorFilter
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.
JSON Example
{
"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"
}
}
aggregatorFilterDefinitionObjIdName
JSON Example
{
"id": "string",
"name": "string"
}string
id
Optional
id
string
name
Optional
name
aggregatorFilteredDevice
JSON Example
{
"keyValuePair": [
{
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"key": "string",
"valueDouble": "number"
}
],
"id": "string"
}string
id
Optional
id
aggregatorKeyObj
JSON Example
{
"displayUnit": "string",
"displayName": "string",
"valueType": "string",
"dataSource": "string",
"key": "string",
"factor": "number",
"keyQualifier": "string",
"isPeriodRequired": "boolean",
"keyType": "string"
}string
displayUnit
Optional
displayUnit
string
displayName
Optional
displayName
string
key
Optional
key
number As double As double
factor
Optional
factor
string
keyQualifier
Optional
keyQualifier
boolean As boolean As boolean
isPeriodRequired
Optional
isPeriodRequired
aggregatorKeyValuePair
JSON Example
{
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"key": "string",
"valueDouble": "number"
}string As int64 As int64
valueInt64
Optional
valueInt64
string
valueString
Optional
valueString
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
string
key
Optional
key
number As double As double
valueDouble
Optional
valueDouble
aggregatorOredOperatorValuePair
JSON Example
{
"operator": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}string As int64 As int64
valueInt64
Optional
valueInt64
string
valueString
Optional
valueString
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
number As double As double
valueDouble
Optional
valueDouble
aggregatorProjection
JSON Example
{
"keyQualifier": "string",
"dataSource": "string",
"key": "string"
}string
keyQualifier
Optional
keyQualifier
string
key
Optional
key
alertsAlertDefinitionId
JSON Example
{
"alertDefId": "string"
}string
alertDefId
Optional
alertDefId
alertsAlertDefinitionInfo
JSON Example
{
"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"
}string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string
lastUpdatedBy
Optional
lastUpdatedBy
integer As int32 As int32
updateVersion
Optional
updateVersion
string
createdBy
Optional
createdBy
string As int64 As int64
createdTime
Optional
createdTime
string
alertDefId
Optional
alertDefId
alertsAlertDefinitionUserSpec
JSON Example
{
"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"
}integer As int32 As int32
cancelCount
Optional
cancelCount
array of string
properties
Optional
properties
array of string
deviceTemplateIds
Optional
deviceTemplateIds
string
name
Optional
name
string
lambda
Optional
lambda
integer As int32 As int32
triggerCount
Optional
triggerCount
boolean As boolean As boolean
isRealTime
Optional
isRealTime
array of string
metrics
Optional
metrics
string
notificationId
Optional
notificationId
string
deviceId
Optional
deviceId
string
recommendation
Optional
recommendation
integer As int32 As int32
duration
Optional
duration
string
deviceTemplateId
Optional
deviceTemplateId
string
notificationDefinitionId
Optional
notificationDefinitionId
string
description
Optional
description
alertsAlertId
JSON Example
{
"alertId": "string"
}string
alertId
Optional
alertId
alertsAlertInfo
JSON Example
{
"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"
}string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string
alertId
Optional
alertId
string
lastUpdatedBy
Optional
lastUpdatedBy
integer As int32 As int32
updateVersion
Optional
updateVersion
string
deviceId
Optional
deviceId
string
createdBy
Optional
createdBy
string As int64 As int64
createdTime
Optional
createdTime
string
userAcknowledged
Optional
userAcknowledged
string
alertDefId
Optional
alertDefId
string
alertDefName
Optional
alertDefName
alertsAlertState
This data structure has no properties.
Enumeration: UNKNOWN_ALERTSTATE, ACTIVE, CANCELLED, ACKNOWLEDGED,
alertsAlertTriggerHistory
JSON Example
{
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
]
}
alertsCreateAlertDefinitionRequest
JSON Example
{
"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"
}integer As int32 As int32
cancelCount
Optional
cancelCount
array of string
properties
Optional
properties
array of string
deviceTemplateIds
Optional
deviceTemplateIds
string
name
Optional
name
string
lambda
Optional
lambda
integer As int32 As int32
triggerCount
Optional
triggerCount
boolean As boolean As boolean
isRealTime
Optional
isRealTime
array of string
metrics
Optional
metrics
string
notificationId
Optional
notificationId
string
deviceId
Optional
deviceId
string
recommendation
Optional
recommendation
integer As int32 As int32
duration
Optional
duration
string
deviceTemplateId
Optional
deviceTemplateId
string
notificationDefinitionId
Optional
notificationDefinitionId
string
description
Optional
description
alertsCreateAlertRequest
JSON Example
{
"alertDefId": "string",
"deviceId": "string",
"triggers": [
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}
]
}string
alertDefId
Optional
alertDefId
string
deviceId
Optional
deviceId
alertsDeleteAlertDefinitionResponse
This data structure has no properties.
alertsListAlertDefinitionsResponse
JSON Example
{
"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"
}
}
alertsListAlertsResponse
JSON Example
{
"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"
}
]
}
alertsSeverity
This data structure has no properties.
Enumeration: UNKNOWN_SEVERITY, CRITICAL, WARNING, INFO,
alertsTemplate
This data structure has no properties.
Enumeration: UNKNOWN_TEMPLATE, THRESHOLD, OFFLINE, RELATIVE,
alertsTrigger
JSON Example
{
"userName": "string",
"valueInt64": "string",
"timeMs": "string",
"metric": "string",
"state": "string",
"valueBoolean": "boolean",
"valueString": "string",
"valueDouble": "number"
}string
userName
Optional
userName
string As int64 As int64
valueInt64
Optional
valueInt64
string As int64 As int64
timeMs
Optional
timeMs
string
metric
Optional
metric
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
string
valueString
Optional
valueString
number As double As double
valueDouble
Optional
valueDouble
alertsUpdateAlertDefinitionRequest
JSON Example
{
"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"
}integer As int32 As int32
cancelCount
Optional
cancelCount
array of string
properties
Optional
properties
array of string
deviceTemplateIds
Optional
deviceTemplateIds
string
name
Optional
name
string
lambda
Optional
lambda
integer As int32 As int32
triggerCount
Optional
triggerCount
boolean As boolean As boolean
isRealTime
Optional
isRealTime
array of string
metrics
Optional
metrics
string
notificationId
Optional
notificationId
string
deviceId
Optional
deviceId
string
recommendation
Optional
recommendation
integer As int32 As int32
duration
Optional
duration
string
alertDefId
Optional
alertDefId
string
deviceTemplateId
Optional
deviceTemplateId
string
notificationDefinitionId
Optional
notificationDefinitionId
string
description
Optional
description
alertsUpdateAlertRequest
JSON Example
{
"state": "string",
"alertId": "string"
}string
alertId
Optional
alertId
commonPageResponse
JSON Example
{
"totalPages": "string",
"totalElements": "string",
"page": "integer",
"pageSize": "integer"
}string As int64 As int64
totalPages
Optional
totalPages
string As int64 As int64
totalElements
Optional
totalElements
integer As int32 As int32
page
Optional
page
integer As int32 As int32
pageSize
Optional
pageSize
Property Of
commonValueType
This data structure has no properties.
Enumeration: UNKNOWN_VALUE_TYPE, INT64, DOUBLE, STRING, BOOLEAN,
consoleApiVersionResponse
JSON Example
{
"supportedApiVersions": [
"string"
],
"currentApiVersion": "string"
}array of string
supportedApiVersions
Optional
supportedApiVersions
string
currentApiVersion
Optional
currentApiVersion
consoleAuditResponse
JSON Example
{
"entityType": "string",
"userId": "string",
"auditInformation": "string",
"auditType": "string",
"deviceId": "string",
"createdTime": "string",
"entityId": "string",
"id": "string"
}string
entityType
Optional
entityType
string
userId
Optional
userId
string
auditInformation
Optional
auditInformation
string
auditType
Optional
auditType
string
deviceId
Optional
deviceId
string As int64 As int64
createdTime
Optional
createdTime
string
entityId
Optional
entityId
string
id
Optional
id
consoleCreateBulkAuditResponse
JSON Example
{
"ids": [
"string"
]
}array of string
ids
Optional
ids
consoleListAuditLogsResponse
JSON Example
{
"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"
}
}
consoleListAuditTypesResponse
JSON Example
{
"auditTypes": [
"string"
]
}array of string
auditTypes
Optional
auditTypes
consoleListEntityTypesResponse
JSON Example
{
"entityTypes": [
"string"
]
}array of string
entityTypes
Optional
entityTypes
consoleLoginDetailResponse
JSON Example
{
"userName": "string",
"orgId": "string",
"status": "string",
"displayName": "string",
"permissions": [
"string"
]
}string
userName
Optional
userName
string
orgId
Optional
orgId
string
status
Optional
status
string
displayName
Optional
displayName
array of string
permissions
Optional
permissions
devicemgmtAgentCommand
JSON Example
{
"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"
}string
deviceId
Optional
deviceId
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
boolean As boolean As boolean
asRoot
Optional
asRoot
string
command
Optional
command
string As int64 As int64
createdTime
Optional
createdTime
string
clientId
Optional
clientId
string
commandId
Optional
commandId
string
execPath
Optional
execPath
string
name
Optional
name
devicemgmtArgumentValueType
This data structure has no properties.
Enumeration: UNKNOWN_VALUE_TYPE, INT64, DOUBLE, STRING, BOOLEAN,
devicemgmtCommand
JSON Example
{
"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"
}string
status
Optional
status
string
name
Optional
name
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
boolean As boolean As boolean
asRoot
Optional
asRoot
string
response
Optional
response
string
command
Optional
command
string As int64 As int64
createdTime
Optional
createdTime
string
clientId
Optional
clientId
string
commandId
Optional
commandId
string
execPath
Optional
execPath
string
deviceId
Optional
deviceId
devicemgmtCommandArgument
JSON Example
{
"type": "string",
"name": "string",
"value": [
"string"
]
}string
name
Optional
name
array of string
value
Optional
value
devicemgmtCommandTemplate
JSON Example
{
"name": "string",
"clientId": "string",
"command": "string",
"asRoot": "boolean",
"execPath": "string",
"arguments": [
{
"type": "string",
"name": "string",
"value": [
"string"
]
}
]
}string
name
Optional
name
string
clientId
Optional
clientId
string
command
Optional
command
boolean As boolean As boolean
asRoot
Optional
asRoot
string
execPath
Optional
execPath
devicemgmtCreateCredentialRequest
JSON Example
{
"requestParams": "string",
"id": "string"
}string
requestParams
Optional
requestParams
string
id
Optional
id
devicemgmtCreateCredentialResponse
JSON Example
{
"credentials": "string"
}string
credentials
Optional
credentials
devicemgmtCustomProperty
JSON Example
{
"name": "string",
"value": "string"
}string
name
Optional
name
string
value
Optional
value
devicemgmtDeleteDeviceResponse
This data structure has no properties.
devicemgmtDeleteDeviceTemplateResponse
This data structure has no properties.
devicemgmtDeleteImageResponse
This data structure has no properties.
devicemgmtDevice
JSON Example
{
"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"
}string
name
Optional
name
string
whitelistStatus
Optional
whitelistStatus
string
templateName
Optional
templateName
string
templateId
Optional
templateId
string As int64 As int64
updateVersion
Optional
updateVersion
string As int64 As int64
createdTime
Optional
createdTime
string
parentId
Optional
parentId
string
orgId
Optional
orgId
string
id
Optional
id
string
parentGatewayId
Optional
parentGatewayId
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
Returned By
devicemgmtDeviceCreateRequest
JSON Example
{
"parentId": "string",
"name": "string",
"templateName": "string"
}string
parentId
Optional
parentId
string
name
Optional
name
string
templateName
Optional
templateName
devicemgmtDeviceProperty
JSON Example
{
"name": "string",
"value": "string"
}string
name
Optional
name
string
value
Optional
value
devicemgmtDeviceTemplate
JSON Example
{
"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"
]
}string
name
Optional
name
integer As int32 As int32
updateVersion
Optional
updateVersion
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string As int64 As int64
createdTime
Optional
createdTime
string
orgId
Optional
orgId
string
id
Optional
id
array of string
childTemplates
Optional
childTemplates
devicemgmtDeviceTemplateId
JSON Example
{
"id": "string"
}string
id
Optional
id
devicemgmtDeviceTemplateRequest
JSON Example
{
"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"
]
}string
name
Optional
name
array of string
childTemplates
Optional
childTemplates
devicemgmtDeviceType
This data structure has no properties.
Enumeration: UNKNOWN_TYPE, GATEWAY, THING,
devicemgmtEnrollmentProvider
JSON Example
{
"providerConfig": "string",
"type": "string"
}string
providerConfig
Optional
providerConfig
string
type
Optional
type
devicemgmtEnrollmentState
This data structure has no properties.
Enumeration: UNKNOWN_STATE, REGISTERED, ENROLLED, UNENROLLED, DELETED,
devicemgmtGetCommandResponse
JSON Example
{
"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"
}
]
}
devicemgmtImage
JSON Example
{
"name": "string",
"dataType": "string",
"imageUrl": "string",
"lastUpdatedBy": "string",
"createdBy": "string",
"createdTime": "string",
"data": "string",
"id": "string",
"lastUpdatedTime": "string"
}string
name
Optional
name
string
dataType
Optional
dataType
string
imageUrl
Optional
imageUrl
string
lastUpdatedBy
Optional
lastUpdatedBy
string
createdBy
Optional
createdBy
string As int64 As int64
createdTime
Optional
createdTime
string
data
Optional
data
string
id
Optional
id
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
devicemgmtImageDetails
JSON Example
{
"imageUrl": "string",
"id": "string",
"sourceType": "string"
}string
imageUrl
Optional
imageUrl
string
id
Optional
id
string
sourceType
Optional
sourceType
devicemgmtInvokeCommandResponse
JSON Example
{
"commandId": "string"
}string
commandId
Optional
commandId
devicemgmtListCommandResponse
JSON Example
{
"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"
}
}
devicemgmtListConnectedDeviceResponse
JSON Example
{
"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"
}
]
}
devicemgmtListDeviceResponse
JSON Example
{
"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"
}
]
}
devicemgmtListDeviceTemplateResponse
JSON Example
{
"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"
}
}
devicemgmtMetricTemplate
JSON Example
{
"timeInterval": "string",
"displayUnit": "string",
"displayName": "string",
"name": "string",
"valueType": "string",
"factor": "number",
"batchSize": "string"
}string As int64 As int64
timeInterval
Optional
timeInterval
string
displayUnit
Optional
displayUnit
string
displayName
Optional
displayName
string
name
Optional
name
number As double As double
factor
Optional
factor
string As int64 As int64
batchSize
Optional
batchSize
devicemgmtOperatorType
This data structure has no properties.
Enumeration: UNKNOWN_OPERATOR, EQUAL_TO, NOT_EQUAL_TO, CONTAINS,
devicemgmtOperatorValuePair
JSON Example
{
"operator": "string",
"value": "string"
}string
value
Optional
value
devicemgmtPropertyType
This data structure has no properties.
Enumeration: UNKNOWN_PROPERTY, SYSTEM_PROPERTY, CUSTOM_PROPERTY, ALL_PROPERTY,
devicemgmtPropertyUpdateRequest
Property update request.
JSON Example
{
"id": "string",
"remove": [
"string"
],
"upsert": [
{
"name": "string",
"value": "string"
}
]
}string
id
Optional
id
array of string
remove
Optional
remove
devicemgmtPropertyUpdateResponse
This data structure has no properties.
devicemgmtSettings
JSON Example
{
"category": "string",
"finalSettings": {},
"settings": {}
}string
category
Optional
category
devicemgmtSystemProperty
JSON Example
{
"name": "string"
}string
name
Optional
name
devicemgmtUnenrollDeviceResponse
This data structure has no properties.
devicemgmtUpdateAgentRequest
Update agent request.
JSON Example
{
"id": "string"
}string
id
Optional
id
devicemgmtUpdateAgentResponse
This data structure has no properties.
devicemgmtUpdateCommandsResponse
JSON Example
{
"commandIds": [
"string"
]
}array of string
commandIds
Optional
commandIds
devicemgmtUpdateDeviceRequest
Update device request.
JSON Example
{
"id": "string",
"name": "string"
}string
id
Optional
id
string
name
Optional
name
devicemgmtUpdateDeviceTemplateRequest
JSON Example
{
"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"
}array of string
childTemplates
Optional
childTemplates
string
id
Optional
id
devicemgmtUploadImageRequest
JSON Example
{
"dataType": "string",
"data": "string",
"name": "string"
}string
dataType
Optional
dataType
string
data
Optional
data
string
name
Optional
name
devicemgmtUploadImageResponse
JSON Example
{
"imageUrl": "string",
"id": "string"
}string
imageUrl
Optional
imageUrl
string
id
Optional
id
grpciamListUsersResponse
JSON Example
{
"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"
}
}
grpciamUser
JSON Example
{
"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"
}string
userName
Optional
userName
string
displayName
Optional
displayName
string
lastUpdatedTime
Optional
lastUpdatedTime
string
createdBy
Optional
createdBy
string
email
Optional
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
helloCreateGreetingRequest
JSON Example
{
"name": "string",
"description": "string"
}string
name
Optional
name
string
description
Optional
description
helloDeleteGreetingResponse
This data structure has no properties.
helloDeleteVersionedReply
This data structure has no properties.
helloEchoResponse
JSON Example
{
"message": "string"
}string
message
Optional
message
helloEmailGreetingRequest
JSON Example
{
"body": "string",
"senderAlias": "string",
"contentType": "string",
"recipients": [
"string"
],
"sendFrom": "string",
"subject": "string"
}string
body
Optional
body
string
senderAlias
Optional
senderAlias
string
contentType
Optional
contentType
array of string
recipients
Optional
recipients
string
sendFrom
Optional
sendFrom
string
subject
Optional
subject
helloEmailGreetingResponse
JSON Example
{
"msg": "string"
}string
msg
Optional
msg
helloGreeting
JSON Example
{
"lastUpdatedTime": "string",
"name": "string",
"greetingType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string",
"description": "string"
}string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string
name
Optional
name
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
createdBy
Optional
createdBy
string As int64 As int64
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
Current version of the greeting object.
string
id
Optional
id
string
description
Optional
description
helloGreetingId
JSON Example
{
"id": "string"
}string
id
Optional
id
helloGreetingType
This data structure has no properties.
Enumeration: UNKNOWN_GREETING_TYPE, HELLO, WELCOME,
helloHelloReply
JSON Example
{
"message": "string"
}string
message
Optional
message
helloListGreetingsResponse
JSON Example
{
"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"
}
}
helloUpdateGreetingRequest
JSON Example
{
"descrpition": "string",
"id": "string"
}string
descrpition
Optional
descrpition
string
id
Optional
id
helloVersionedReply
JSON Example
{
"fullName": "string",
"address": "string",
"id": "string",
"name": "string"
}string
fullName
Optional
fullName
string
address
Optional
address
string As int64 As int64
id
Optional
id
string
name
Optional
name
iamAssigneeType
- UNKNOWN: Unknown Assignee Type
- USER: User Assignee Type
- DEVICE: Device Assignee Type
This data structure has no properties.
Enumeration: UNKNOWN, USER, DEVICE,
iamCreateGroupRequest
JSON Example
{
"name": "string",
"roles": [
"string"
],
"description": "string"
}string
name
Optional
name
array of string
roles
Optional
roles
string
description
Optional
description
iamCreateOrganizationRequest
JSON Example
{
"status": "string",
"name": "string",
"parentId": "string"
}
iamCreateRoleRequest
JSON Example
{
"permissions": [
"integer"
],
"name": "string",
"description": "string"
}array of integer
permissions
Optional
permissions
string
name
Optional
name
string
description
Optional
description
iamCreateRootOrganizationRequest
JSON Example
{
"createUserRequest": {
"userName": "string",
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"groups": [
"string"
],
"password": "string",
"email": "string"
},
"createOrganizationRequest": {
"status": "string",
"name": "string",
"parentId": "string"
}
}
iamCreateUserRequest
JSON Example
{
"userName": "string",
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"groups": [
"string"
],
"password": "string",
"email": "string"
}string
userName
Optional
userName
string
displayName
Optional
displayName
array of string
roles
Optional
roles
array of string
groups
Optional
groups
string
password
Optional
password
string
email
Optional
iamDeleteGroupResponse
This data structure has no properties.
iamDeleteOrganizationResponse
This data structure has no properties.
iamDeleteRoleResponse
This data structure has no properties.
iamDeleteUserResponse
This data structure has no properties.
iamForgotPasswordResponse
This data structure has no properties.
iamGroup
JSON Example
{
"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"
}string
lastUpdatedTime
Optional
lastUpdatedTime
string
name
Optional
name
string
lastUpdatedBy
Optional
lastUpdatedBy
integer As int32 As int32
updateVersion
Optional
updateVersion
string
createdBy
Optional
createdBy
string
createdTime
Optional
createdTime
string
orgId
Optional
orgId
string
id
Optional
id
string
description
Optional
description
iamGroupId
JSON Example
{
"id": "string"
}string
id
Optional
id
iamListGroupsResponse
JSON Example
{
"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"
}
]
}
iamListMembersResponse
JSON Example
{
"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"
}
]
}
iamListOrganizationsResponse
JSON Example
{
"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"
}
}
iamListPermissionsResponse
JSON Example
{
"permissions": [
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}
]
}
iamListRolesResponse
JSON Example
{
"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"
}
]
}
iamLogoutResponse
This data structure has no properties.
iamMembership
JSON Example
{
"createdBy": "string",
"assignedRoles": [
"string"
],
"assigneeId": "string",
"assigneeType": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"assignedGroups": [
"string"
],
"createdTime": "string",
"updateVersion": "string",
"id": "string",
"lastUpdatedTime": "string"
}string
createdBy
Optional
createdBy
array of string
assignedRoles
Optional
assignedRoles
string
assigneeId
Optional
assigneeId
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
array of string
assignedGroups
Optional
assignedGroups
string
createdTime
Optional
createdTime
string
updateVersion
Optional
updateVersion
string
id
Optional
id
string
lastUpdatedTime
Optional
lastUpdatedTime
iamOrganization
JSON Example
{
"status": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"updateVersion": "integer",
"createdBy": "string",
"parentId": "string",
"createdTime": "string",
"orgId": "string",
"id": "string",
"name": "string"
}string
lastUpdatedTime
Optional
lastUpdatedTime
string
lastUpdatedBy
Optional
lastUpdatedBy
integer As int32 As int32
updateVersion
Optional
updateVersion
string
createdBy
Optional
createdBy
string
parentId
Optional
parentId
string
createdTime
Optional
createdTime
string
orgId
Optional
orgId
string
id
Optional
id
string
name
Optional
name
iamOrganizationId
JSON Example
{
"id": "string"
}string
id
Optional
id
iamPermission
JSON Example
{
"permissionNumber": "integer",
"name": "string",
"description": "string"
}integer As int32 As int32
permissionNumber
Optional
permissionNumber
string
name
Optional
name
string
description
Optional
description
iamResetPasswordResponse
This data structure has no properties.
iamRevokeTokenResponse
This data structure has no properties.
iamRole
JSON Example
{
"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"
}string
lastUpdatedTime
Optional
lastUpdatedTime
string
name
Optional
name
string
lastUpdatedBy
Optional
lastUpdatedBy
integer As int32 As int32
updateVersion
Optional
updateVersion
string
createdBy
Optional
createdBy
string
createdTime
Optional
createdTime
string
orgId
Optional
orgId
string
id
Optional
id
string
description
Optional
description
iamRoleId
JSON Example
{
"id": "string"
}string
id
Optional
id
iamRootOrganizationResponse
JSON Example
{
"userId": "string",
"orgId": "string"
}string
userId
Optional
userId
string
orgId
Optional
orgId
iamStatus
- UNKNOWN_STATUS: Unkown status
- INACTIVE: Inactive status
- ACTIVE: Active status
- SUSPENDED: Suspended status
This data structure has no properties.
Enumeration: UNKNOWN_STATUS, INACTIVE, ACTIVE, SUSPENDED,
iamToken
JSON Example
{
"accessTokenExpiresAt": "string",
"expiresInSecs": "string",
"refreshToken": "string",
"refreshTokenExpiresAt": "string",
"accessToken": "string"
}string As int64 As int64
accessTokenExpiresAt
Optional
accessTokenExpiresAt
string As int64 As int64
expiresInSecs
Optional
expiresInSecs
string
refreshToken
Optional
refreshToken
string As int64 As int64
refreshTokenExpiresAt
Optional
refreshTokenExpiresAt
string
accessToken
Optional
accessToken
iamUpdateGroupRequest
JSON Example
{
"description": "string",
"updateVersion": "integer",
"id": "string",
"roles": [
"string"
],
"name": "string"
}string
description
Optional
description
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
array of string
roles
Optional
roles
string
name
Optional
name
iamUpdateOrganizationRequest
JSON Example
{
"status": "string",
"parentId": "string",
"updateVersion": "integer",
"id": "string",
"name": "string"
}string
parentId
Optional
parentId
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
string
name
Optional
name
iamUpdateRoleRequest
JSON Example
{
"description": "string",
"permissions": [
"integer"
],
"updateVersion": "integer",
"id": "string",
"name": "string"
}string
description
Optional
description
array of integer
permissions
Optional
permissions
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
string
name
Optional
name
iamUpdateUserRequest
JSON Example
{
"status": "string",
"displayName": "string",
"roles": [
"string"
],
"email": "string",
"updateVersion": "integer",
"groups": [
"string"
],
"password": "string",
"id": "string"
}string
displayName
Optional
displayName
array of string
roles
Optional
roles
string
email
Optional
integer As int32 As int32
updateVersion
Optional
updateVersion
array of string
groups
Optional
groups
string
password
Optional
password
string
id
Optional
id
iamUserId
JSON Example
{
"id": "string"
}string
id
Optional
id
iotcconsoleListUsersResponse
JSON Example
{
"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"
}
}
iotcconsoleUser
JSON Example
{
"userName": "string",
"status": "string",
"displayName": "string",
"lastUpdatedTime": "string",
"lastUpdatedBy": "string",
"orgId": "string",
"createdBy": "string",
"createdTime": "string",
"updateVersion": "integer",
"id": "string"
}string
userName
Optional
userName
string
status
Optional
status
string
displayName
Optional
displayName
string
lastUpdatedTime
Optional
lastUpdatedTime
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
createdBy
Optional
createdBy
string
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
iotcdevicemgmtDeviceId
JSON Example
{
"id": "string"
}string
id
Optional
id
iotcdevicemgmtDeviceToken
JSON Example
{
"deviceId": "string",
"accessToken": "string"
}string
deviceId
Optional
deviceId
string
accessToken
Optional
accessToken
lcmCampaignHistoryInfoMessage
JSON Example
{
"started": "string",
"timestamp": "string",
"completed": "string",
"errorMessage": "string",
"state": "string",
"error": "boolean"
}string
started
Optional
started
string As uint64 As uint64
timestamp
Optional
timestamp
string
completed
Optional
completed
string
errorMessage
Optional
errorMessage
string
state
Optional
state
boolean As boolean As boolean
error
Optional
error
lcmCampaignInfoMessage
JSON Example
{
"status": "string",
"hasApproval": "boolean",
"name": "string",
"creationTime": "string",
"postDeliveryCallback": "string",
"preDeliveryCallback": "string",
"packages": {
"packages": [
"string"
]
},
"approvalNeeded": "boolean",
"id": "string",
"description": "string"
}string
status
Optional
status
boolean As boolean As boolean
hasApproval
Optional
hasApproval
string
name
Optional
name
string As int64 As int64
creationTime
Optional
creationTime
string
postDeliveryCallback
Optional
postDeliveryCallback
string
preDeliveryCallback
Optional
preDeliveryCallback
boolean As boolean As boolean
approvalNeeded
Optional
approvalNeeded
string
id
Optional
id
string
description
Optional
description
lcmCampaignSettingsMessage
This data structure has no properties.
object
settings
Optional
settings
lcmDownloadProgressMessage
JSON Example
{
"packagesProgress": [
{
"progress": "string",
"total": "string",
"id": "string"
}
]
}
lcmGatewayCommandMessage
JSON Example
{
"command": "string",
"commandId": "string",
"arguments": [
"string"
]
}string
command
Optional
command
string
commandId
Optional
commandId
array of string
arguments
Optional
arguments
lcmGatewayInfo
JSON Example
{
"gatewayId": "string",
"state": "string",
"closed": "boolean"
}string
gatewayId
Optional
gatewayId
string
state
Optional
state
boolean As boolean As boolean
closed
Optional
closed
lcmIotcPackagesMessage
JSON Example
{
"packages": [
"string"
]
}array of string
packages
Optional
packages
lcmPackageDownloadProgressMessage
JSON Example
{
"progress": "string",
"total": "string",
"id": "string"
}string As uint64 As uint64
progress
Optional
progress
string As uint64 As uint64
total
Optional
total
string
id
Optional
id
lcmStateMessage
JSON Example
{
"state": "string"
}string
state
Optional
state
metricingestMetricDataPoint
JSON Example
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}string As int64 As int64
timeMs
Optional
timeMs
string As int64 As int64
valueInt64
Optional
valueInt64
number As double As double
valueDouble
Optional
valueDouble
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
string
valueString
Optional
valueString
metricingestMetricDetail
JSON Example
{
"dataPoints": [
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}
],
"metricName": "string"
}string
metricName
Optional
metricName
metricingestMetricIngestRequest
JSON Example
{
"metricDetails": [
{
"dataPoints": [
{
"timeMs": "string",
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"valueString": "string"
}
],
"metricName": "string"
}
],
"deviceId": "string"
}string
deviceId
Optional
deviceId
metricingestMetricIngestResponse
JSON Example
{
"responseMessage": "string"
}string
responseMessage
Optional
responseMessage
metricqueryMetric
JSON Example
{
"tsData": [
{
"timeMs": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}
],
"name": "string"
}string
name
Optional
name
metricqueryMetricDataEntry
JSON Example
{
"timeMs": "string",
"valueInt64": "string",
"valueString": "string",
"valueBoolean": "boolean",
"valueDouble": "number"
}string As int64 As int64
timeMs
Optional
timeMs
string As int64 As int64
valueInt64
Optional
valueInt64
string
valueString
Optional
valueString
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
number As double As double
valueDouble
Optional
valueDouble
notificationsAdditionalNotificationDetails
JSON Example
{
"valueInt64": "string",
"valueDouble": "number",
"valueBoolean": "boolean",
"key": "string",
"valueString": "string"
}string As int64 As int64
valueInt64
Optional
valueInt64
number As double As double
valueDouble
Optional
valueDouble
boolean As boolean As boolean
valueBoolean
Optional
valueBoolean
string
key
Optional
key
string
valueString
Optional
valueString
notificationsAuthenticationType
This data structure has no properties.
Enumeration: UNKNOWN_AUTHENTICATION_TYPE, NO_AUTH, BASIC,
notificationsCreateNotificationDefinitionRequest
JSON Example
{
"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"
}string
name
Optional
name
string
notificationDestinationId
Optional
notificationDestinationId
integer As int32 As int32
retryCount
Optional
retryCount
string
description
Optional
description
notificationsCreateNotificationDestinationRequest
JSON Example
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"name": "string",
"certificate": "string",
"sslTlsVersion": "string",
"host": "string",
"password": "string",
"port": "integer",
"description": "string"
}string
username
Optional
username
string
name
Optional
name
string
certificate
Optional
certificate
string
host
Optional
host
string
password
Optional
password
integer As int32 As int32
port
Optional
port
string
description
Optional
description
notificationsCreateNotificationInstanceRequest
JSON Example
{
"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"
}string
entityName
Optional
entityName
string
entityType
Optional
entityType
string
entityId
Optional
entityId
string
notificationDefinitionId
Optional
notificationDefinitionId
string
entityState
Optional
entityState
notificationsCreateSystemNotificationInstanceRequest
JSON Example
{
"content": "string",
"endTime": "string",
"startTime": "string",
"title": "string"
}string
content
Optional
content
string As int64 As int64
endTime
Optional
endTime
string As int64 As int64
startTime
Optional
startTime
string
title
Optional
title
notificationsDeleteNotificationDefinitionResponse
This data structure has no properties.
notificationsDeleteNotificationDestinationResponse
This data structure has no properties.
notificationsDeleteSystemNotificationInstanceResponse
This data structure has no properties.
notificationsEmailParameters
JSON Example
{
"emailRecipients": [
"string"
],
"senderEmailAddress": "string",
"emailSubjectTemplate": "string",
"emailBodyTemplate": "string",
"senderName": "string"
}array of string
emailRecipients
Optional
It consists of a list of email recipients and it is mandatory to have atleast one recipient.
string
senderEmailAddress
Optional
senderEmailAddress
string
emailSubjectTemplate
Optional
emailSubjectTemplate
string
emailBodyTemplate
Optional
emailBodyTemplate
string
senderName
Optional
senderName
notificationsHttpHeaders
JSON Example
{
"value": "string",
"key": "string"
}string
value
Optional
value
string
key
Optional
key
notificationsHttpParameters
JSON Example
{
"relativePath": "string",
"payloadTemplate": "string",
"headers": [
{
"value": "string",
"key": "string"
}
]
}string
relativePath
Optional
relativePath
string
payloadTemplate
Optional
payloadTemplate
notificationsListNotificationDefinitionsResponse
JSON Example
{
"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"
}
]
}array of notificationsNotificationDefinition
notificationDefinitions
Optional
notificationDefinitions
notificationsListNotificationDestinationsResponse
JSON Example
{
"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"
}
]
}array of notificationsNotificationDestination
notificationDestinations
Optional
notificationDestinations
notificationsListNotificationInstancesResponse
JSON Example
{
"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"
}
}
notificationsListSystemNotificationInstancesResponse
JSON Example
{
"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
Optional
systemNotificationInstances
notificationsNotificationDefinition
JSON Example
{
"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"
}string
description
Optional
description
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string
notificationDestinationId
Optional
notificationDestinationId
integer As int32 As int32
updateVersion
Optional
updateVersion
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
createdBy
Optional
createdBy
string
notificationDestinationName
Optional
Below properties are populated only for console and are not available as part of normal response.
string As int64 As int64
createdTime
Optional
createdTime
integer As int32 As int32
retryCount
Optional
retryCount
string
id
Optional
id
string
name
Optional
name
Property Of
Returned By
notificationsNotificationDefinitionId
JSON Example
{
"id": "string"
}string
id
Optional
id
notificationsNotificationDestination
JSON Example
{
"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"
}string
username
Optional
username
string
description
Optional
description
string
certificate
Optional
certificate
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
integer As int32 As int32
port
Optional
port
string
host
Optional
host
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
createdBy
Optional
createdBy
string As int64 As int64
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
updateVersion
string
id
Optional
id
string
name
Optional
name
Returned By
notificationsNotificationDestinationId
JSON Example
{
"id": "string"
}string
id
Optional
id
notificationsNotificationInstance
JSON Example
{
"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"
}string
status
Optional
status
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
integer As int32 As int32
responseStatus
Optional
responseStatus
string
entityName
Optional
entityName
string
entityType
Optional
entityType
string
notificationType
Optional
notificationType
string
notificationDefinitionId
Optional
notificationDefinitionId
string
responseBody
Optional
responseBody
string
lastUpdatedBy
Optional
lastUpdatedBy
string
orgId
Optional
orgId
string
emailBody
Optional
emailBody
string
createdBy
Optional
createdBy
string
notificationDefinitionName
Optional
Below properties are populated only for console and are not available as part of normal response.
string As int64 As int64
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
updateVersion
string
entityId
Optional
entityId
string
emailSubject
Optional
emailSubject
string
id
Optional
id
string
entityState
Optional
entityState
notificationsNotificationInstanceId
JSON Example
{
"id": "string"
}string
id
Optional
id
notificationsNotificationProtocol
This data structure has no properties.
Enumeration: UNKNOWN_NOTIFICATION_PROTOCOL, HTTP, SMTP,
notificationsSystemNotificationInstance
JSON Example
{
"status": "string",
"lastUpdatedTime": "string",
"title": "string",
"content": "string",
"lastUpdatedBy": "string",
"createdBy": "string",
"startTime": "string",
"createdTime": "string",
"updateVersion": "integer",
"endTime": "string",
"id": "string"
}string
status
Optional
status
string As int64 As int64
lastUpdatedTime
Optional
lastUpdatedTime
string
title
Optional
title
string
content
Optional
content
string
lastUpdatedBy
Optional
lastUpdatedBy
string
createdBy
Optional
createdBy
string As int64 As int64
startTime
Optional
startTime
string As int64 As int64
createdTime
Optional
createdTime
integer As int32 As int32
updateVersion
Optional
updateVersion
string As int64 As int64
endTime
Optional
endTime
string
id
Optional
id
Returned By
notificationsSystemNotificationInstanceId
JSON Example
{
"id": "string"
}string
id
Optional
id
notificationsTlsVersion
This data structure has no properties.
Enumeration: UNKNOWN_TLS_VERSION, NO_CERT, TLS1_2,
notificationsUpdateNotificationDefinitionRequest
JSON Example
{
"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"
}string
description
Optional
description
string
notificationDestinationId
Optional
notificationDestinationId
integer As int32 As int32
retryCount
Optional
retryCount
string
id
Optional
id
string
name
Optional
name
notificationsUpdateNotificationDestinationRequest
JSON Example
{
"username": "string",
"authenticationType": "string",
"protocol": "string",
"description": "string",
"certificate": "string",
"sslTlsVersion": "string",
"port": "integer",
"host": "string",
"password": "string",
"id": "string",
"name": "string"
}string
username
Optional
username
string
description
Optional
description
string
certificate
Optional
certificate
integer As int32 As int32
port
Optional
port
string
host
Optional
host
string
password
Optional
password
string
id
Optional
id
string
name
Optional
name
notificationsUpdateSystemNotificationInstanceRequest
JSON Example
{
"content": "string",
"endTime": "string",
"id": "string",
"startTime": "string",
"title": "string"
}string
content
Optional
content
string As int64 As int64
endTime
Optional
endTime
string
id
Optional
id
string As int64 As int64
startTime
Optional
startTime
string
title
Optional
title
protobufListValue
ListValue is a wrapper around a repeated field of values.
The JSON representation for ListValue is JSON array.
JSON Example
{
"values": [
"protobufValue Object"
]
}
protobufNullValue
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.
This data structure has no properties.
protobufStruct
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.
This data structure has no properties.
object
fields
Optional
Unordered map of dynamically typed values.
protobufValue
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.
JSON Example
{
"numberValue": "number",
"boolValue": "boolean",
"stringValue": "string",
"structValue": "protobufStruct Object",
"listValue": "protobufListValue Object",
"nullValue": "string"
}number As double As double
numberValue
Optional
Represents a double value.
boolean As boolean As boolean
boolValue
Optional
Represents a boolean value.
string
stringValue
Optional
Represents a string value.
Node: apidepo-liferay-dxp-v1-be-w-0:8080: