Retrieve Device Details
get
/iot/api/v2/devices/{device-id}
Retrieve details of device, identified by device ID
Request
Path Parameters
-
device-id: string
ID of device to be retrieved from Cloud Service
Query Parameters
-
expand(optional): string
The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
-
fields(optional): string
The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : DeviceImpl_receive
Type:
Show Source
object-
childrenDevices:
object childrenDevices
Property description was not set
-
connectivityStatus:
object ConnectivityStatus_receive
-
created:
integer
Property description was not set
-
createdAsLong:
integer
Property description was not set
-
description:
string
Property description was not set
-
deviceModels:
array deviceModels
Property description was not set
-
deviceType:
string
One of [UNKNOWN, GATEWAY, DIRECTLY_CONNECTED_DEVICE, INDIRECTLY_CONNECTED_DEVICE].
-
deviceUID:
string
Property description was not set
-
directlyConnectedOwner:
object directlyConnectedOwner
-
enabled:
boolean
Property description was not set
-
endpointId:
string
Property description was not set
-
endpointName:
string
Property description was not set
-
enrollmentTime:
integer
Property description was not set
-
enrollmentTimeAsLong:
integer
Property description was not set
-
hardwareRevision:
string
Property description was not set
-
lastHeardTime:
integer
Property description was not set
-
lifecycleState:
string
One of [REGISTERED, ACTIVATED, ENABLED, DISABLED, DECOMMISSIONED, UNKNOWN].
-
location:
object location
-
logs:
object Logs_receive
-
manufacturer:
string
Property description was not set
-
metadata:
object metadata
Property description was not set
-
modelNumber:
string
Property description was not set
-
partnerName:
string
Property description was not set
-
resources:
object resources
Property description was not set
-
serialNumber:
string
Property description was not set
- sharedSecret: string
-
softwareRevision:
string
Property description was not set
-
softwareVersion:
string
Property description was not set
Nested Schema : childrenDevices
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : ConnectivityStatus_receive
Type:
Show Source
object-
lastHeardEpochTime:
integer
Property description was not set
-
onlineSinceEpochTime:
integer
Property description was not set
-
onlineSinceTime:
integer
Property description was not set
-
status:
string
One of [NEVER_HEARD_FROM, OFFLINE, ONLINE].
Nested Schema : directlyConnectedOwner
Type:
Show Source
object-
links(optional):
array links
The set of API navigation links.
Nested Schema : location
Type:
Show Source
object-
links(optional):
array links
The set of API navigation links.
Nested Schema : Logs_receive
Type:
Show Source
object-
logCount:
integer
Property description was not set
-
logs:
object LogBuffer_receive
-
logType:
string
One of [ACTIVATION].
Nested Schema : metadata
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : resources
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : DeviceModelModel_receive
Type:
Show Source
object-
actions:
array actions
Property description was not set
-
attributes:
array attributes
Property description was not set
-
created:
integer
Property description was not set
-
createdAsDate:
integer
Property description was not set
-
description:
string
Property description was not set
-
draft:
boolean
Property description was not set
-
formatObjects:
array formatObjects
Property description was not set
-
lastModified:
integer
Property description was not set
-
lastModifiedAsDate:
integer
Property description was not set
-
name:
string
Property description was not set
-
system:
boolean
Property description was not set
-
uRN:
string
Property description was not set
-
userLastModified:
string
Property description was not set
Nested Schema : DeviceModelActionModel_receive
Type:
Show Source
object-
alias:
string
Property description was not set
-
argType:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
-
arguments:
array arguments
Property description was not set
-
description:
string
Property description was not set
-
name:
string
Property description was not set
-
range:
string
Property description was not set
Nested Schema : DeviceModelActionArgumentModel_receive
Type:
Show Source
object-
description:
string
Property description was not set
-
name:
string
Property description was not set
-
range:
string
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
Nested Schema : DeviceModelAttributeModel_receive
Type:
Show Source
object-
alias:
string
Property description was not set
-
description:
string
Property description was not set
-
name:
string
Property description was not set
-
range:
string
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
-
writable:
boolean
Property description was not set
Nested Schema : MessageFormatModel_receive
Type:
Show Source
object-
description:
string
Property description was not set
-
deviceModel:
string
Property description was not set
-
explorationId:
string
Property description was not set
-
name:
string
Property description was not set
-
severity:
string
Property description was not set
-
sourceId:
string
Property description was not set
-
sourceType:
string
One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].
-
type:
string
One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].
-
uRN:
string
Property description was not set
-
value:
object MessageFormatValue_receive
Nested Schema : MessageFormatValue_receive
Type:
Show Source
object-
fields:
array fields
Property description was not set
Nested Schema : MessageFormatField_receive
Type:
Show Source
object-
name:
string
Property description was not set
-
optional:
boolean
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : LogBuffer_receive
Type:
Show Source
object-
empty:
boolean
Property description was not set
-
full:
boolean
Property description was not set
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
406 Response
Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Examples
curl -X GET
-u <username>:<password>
http://iotserver/iot/api/v2/devices/{device-id}
Example of Response Body
The following example shows the content of the response body in JSON format
{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"deviceModels":[
{
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:418b",
"name":"Message format name",
"description":"Message format description",
"deviceModel":"Device model that created this message format",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"DATA",
"value":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"fields":[
{
"name":"Name of the message format field",
"optional":false,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING"
}
]
}
}
],
"createdAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"description":"Optional description of the device model",
"userLastModified":"Name of the user who last to modify this device model",
"urn":"urn:example:unique:identifier:of:the:resource:70c1",
"system":false,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"draft":false,
"name":"Human friendly name of the device model",
"attributes":[
{
"name":"A name for the attribute",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING",
"writable":false
}
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"actions":[
{
"name":"A name for the action",
"argType":"STRING",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
]
}
]
}
],
"software":[
{
"artifact":{
"headers":{
"headers_key1":"headers_value1",
"headers_key2":"headers_value2",
"headers_key3":"headers_value3"
},
"related":[
{
"dependencyId":"f8f76f464d-7457",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"11901677a92-87d",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"type":"UNKNOWN"
}
],
"created":1469184297746,
"name":"The name of the artifact. This name does not have to be unique within the system. For example, a name of 'com.mycompany.device.adapter' might be present for multiple versions. But it is constant during the artifact lifecycle.",
"files":[
"files_1",
"files_2",
"files_3"
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"573b38e812ef-3868",
"lastModified":1469184297746,
"type":"UNKNOWN",
"version":"The version of the artifact, using the Java version string format: major.minor.micro is recommended. The name/version pair uniquely identifies an artifact. Like the name, it is also not changed during the lifecycle.",
"dependencies":[
{
"dependencyId":"11bf26916232-4951",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"617ac93757-7585",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"type":"UNKNOWN"
}
],
"status":"CREATED"
},
"request":{
"created":1469184297746,
"errorCode":"String with error code for current request",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"71961f254bf9-22dc",
"type":"INSTALL",
"ownerId":"36441fbb684b-beb",
"status":"PENDING",
"errorDetails":"String with error details for current request"
},
"deviceAppId":"5a1b32f963a1-6ea7",
"installationProgress":12345,
"artifactId":"6dbf60754f71-4e67",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"48c321a154ef-3a8d",
"state":"UNKNOWN",
"lastModified":1469184297746,
"deviceApp":{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"appVersion":"Application version",
"createdAsString":"2016-07-22T10:44:57.746Z",
"deviceModels":[
{
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:67e8",
"name":"Message format name",
"description":"Message format description",
"deviceModel":"Device model that created this message format",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"DATA",
"value":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"fields":[
{
"name":"Name of the message format field",
"optional":false,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING"
}
]
}
}
],
"createdAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"description":"Optional description of the device model",
"userLastModified":"Name of the user who last to modify this device model",
"urn":"urn:example:unique:identifier:of:the:resource:3b69",
"system":false,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"draft":false,
"name":"Human friendly name of the device model",
"attributes":[
{
"name":"A name for the attribute",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING",
"writable":false
}
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"actions":[
{
"name":"A name for the action",
"argType":"STRING",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
]
}
]
}
],
"devices":[
{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"deviceModels":[
{
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:4f3",
"name":"Message format name",
"description":"Message format description",
"deviceModel":"Device model that created this message format",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"DATA",
"value":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"fields":[
{
"name":"Name of the message format field",
"optional":false,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING"
}
]
}
}
],
"createdAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"description":"Optional description of the device model",
"userLastModified":"Name of the user who last to modify this device model",
"urn":"urn:example:unique:identifier:of:the:resource:3a40",
"system":false,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"draft":false,
"name":"Human friendly name of the device model",
"attributes":[
{
"name":"A name for the attribute",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING",
"writable":false
}
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"actions":[
{
"name":"A name for the action",
"argType":"STRING",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
]
}
]
}
],
"softwareRevision":"A string representing the software revision.",
"description":"Endpoint description",
"type":"UNKNOWN",
"enabled":false,
"manufacturer":"A string, generally an Organizationally Unique Identifier (OUI), that describes the manufacturer of the device.",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"60f434dc1a96-268d",
"state":"REGISTERED",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746,
"directlyConnectedOwner":{
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"2aa241162d1f-496f",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"d0a28893bd9-7b04",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"REGISTERED",
"id":"7b11456b28d9-7",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746
},
"serialNumber":"A string (which should be unique across all devices of this modelNumber/manufacturer) uniquely identifying the specific device.",
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"19bc588062bc-3824",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"fa542f209e-2481",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"57fc464629df-3685",
"hardwareRevision":"A string representing the hardware revision.",
"name":"Endpoint name",
"location":{
"altitude":12.34,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"latitude":12.34,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"uncertainty":12.34,
"longitude":12.34
},
"modelNumber":"A string representing the specific model of the device.",
"softwareVersion":"A string representing the software version."
}
],
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"appName":"Application name",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"4244c732850-65fc",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"1c6a4a5a7f02-d8a",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"appHostEndpointId":"79cf6df6f18-1f63",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"appType":"APPLICATION",
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"62d572e228b-66c1",
"state":"REGISTERED",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746,
"directlyConnectedOwner":{
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"682754956312-1f91",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"65d850abb7d-59d9",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"REGISTERED",
"id":"340cab1a70-541a",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746
}
},
"bundle":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"UNKNOWN",
"startLevel":12345
},
"deviceId":"19813c5a1204-e17"
}
],
"softwareRevision":"A string representing the software revision.",
"description":"Endpoint description",
"type":"UNKNOWN",
"enabled":false,
"manufacturer":"A string, generally an Organizationally Unique Identifier (OUI), that describes the manufacturer of the device.",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"796531a6321a-3ae",
"state":"REGISTERED",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746,
"directlyConnectedOwner":{
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"546f35ee54e8-6435",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"47ba406f37b8-7fce",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"REGISTERED",
"id":"1b303fd65662-7afc",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746
},
"serialNumber":"A string (which should be unique across all devices of this modelNumber/manufacturer) uniquely identifying the specific device.",
"createdAsString":"2016-07-22T10:44:57.746Z",
"devices":[
{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"deviceModels":[
{
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:749b",
"name":"Message format name",
"description":"Message format description",
"deviceModel":"Device model that created this message format",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"DATA",
"value":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"fields":[
{
"name":"Name of the message format field",
"optional":false,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING"
}
]
}
}
],
"createdAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"description":"Optional description of the device model",
"userLastModified":"Name of the user who last to modify this device model",
"urn":"urn:example:unique:identifier:of:the:resource:72b7",
"system":false,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"draft":false,
"name":"Human friendly name of the device model",
"attributes":[
{
"name":"A name for the attribute",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING",
"writable":false
}
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"actions":[
{
"name":"A name for the action",
"argType":"STRING",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
]
}
]
}
],
"software":[
{
"artifact":{
"headers":{
"headers_key1":"headers_value1",
"headers_key2":"headers_value2",
"headers_key3":"headers_value3"
},
"related":[
{
"dependencyId":"31c527903ad6-785d",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"ac33cd6e94-5529",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"type":"UNKNOWN"
}
],
"created":1469184297746,
"name":"The name of the artifact. This name does not have to be unique within the system. For example, a name of 'com.mycompany.device.adapter' might be present for multiple versions. But it is constant during the artifact lifecycle.",
"files":[
"files_1",
"files_2",
"files_3"
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"22d82c8cf19-6cbd",
"lastModified":1469184297746,
"type":"UNKNOWN",
"version":"The version of the artifact, using the Java version string format: major.minor.micro is recommended. The name/version pair uniquely identifies an artifact. Like the name, it is also not changed during the lifecycle.",
"dependencies":[
{
"dependencyId":"7d095b8d2e19-26f2",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"4dea3d9c237c-2671",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"type":"UNKNOWN"
}
],
"status":"CREATED"
},
"request":{
"created":1469184297746,
"errorCode":"String with error code for current request",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"565a7e847dd8-66ff",
"type":"INSTALL",
"ownerId":"4f556b1b4e90-6139",
"status":"PENDING",
"errorDetails":"String with error details for current request"
},
"deviceAppId":"70296efeb07-7366",
"installationProgress":12345,
"artifactId":"5e77415a5b16-68ea",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"39eb4e41b38-47a8",
"state":"UNKNOWN",
"lastModified":1469184297746,
"deviceApp":{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"appVersion":"Application version",
"createdAsString":"2016-07-22T10:44:57.746Z",
"deviceModels":[
{
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:3cd0",
"name":"Message format name",
"description":"Message format description",
"deviceModel":"Device model that created this message format",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"DATA",
"value":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"fields":[
{
"name":"Name of the message format field",
"optional":false,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING"
}
]
}
}
],
"createdAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"description":"Optional description of the device model",
"userLastModified":"Name of the user who last to modify this device model",
"urn":"urn:example:unique:identifier:of:the:resource:65b0",
"system":false,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"draft":false,
"name":"Human friendly name of the device model",
"attributes":[
{
"name":"A name for the attribute",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"type":"STRING",
"writable":false
}
],
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"actions":[
{
"name":"A name for the action",
"argType":"STRING",
"description":"A human friendly description",
"alias":"Optional alternative name",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
]
}
]
}
],
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"appName":"Application name",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"a711c045be0-52da",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"26f02e3fdb-5bf1",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"appHostEndpointId":"c87b101a14-4e99",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"appType":"APPLICATION",
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"a35385725a0-1f46",
"state":"REGISTERED",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746,
"directlyConnectedOwner":{
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"7b9613c139e3-72a0",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"64be260b3b92-48fe",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"REGISTERED",
"id":"79f92604891-3bdc",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746
}
},
"bundle":{
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"UNKNOWN",
"startLevel":12345
},
"deviceId":"352e5ad6571c-274e"
}
],
"softwareRevision":"A string representing the software revision.",
"description":"Endpoint description",
"type":"UNKNOWN",
"enabled":false,
"manufacturer":"A string, generally an Organizationally Unique Identifier (OUI), that describes the manufacturer of the device.",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"23be52dd78ec-2e45",
"state":"REGISTERED",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746,
"directlyConnectedOwner":{
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"54eb3d4828fb-2383",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"20ef43d214f-72cc",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"type":"DEVICE",
"connectivity":{
"lastHeardTime":1469184297746,
"onlineSinceTime":1469184297746,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"connectivityStatus":"NEVER_HEARD_FROM",
"onlineSinceTimeAsString":"2016-07-22T10:44:57.746Z"
},
"name":"Endpoint name",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"state":"REGISTERED",
"id":"6e561c2e696f-2ec5",
"sharedSecret":"Endpoint Shared Secret",
"activationTime":1469184297746
},
"serialNumber":"A string (which should be unique across all devices of this modelNumber/manufacturer) uniquely identifying the specific device.",
"createdAsString":"2016-07-22T10:44:57.746Z",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"7d725d8c5c91-47f8",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"682652d37ef-12fa",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"1da7499f3254-4e0a",
"hardwareRevision":"A string representing the hardware revision.",
"name":"Endpoint name",
"location":{
"altitude":12.34,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"latitude":12.34,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"uncertainty":12.34,
"longitude":12.34
},
"modelNumber":"A string representing the specific model of the device.",
"softwareVersion":"A string representing the software version."
}
],
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"lastHeardTimeAsString":"2016-07-22T10:44:57.746Z",
"created":1469184297746,
"resources":[
{
"methods":[
"methods_1",
"methods_2",
"methods_3"
],
"endpointId":"191a5963149e-24b6",
"description":"Human friendly description of the resource",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"54221a25347a-7ec6",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"48446b5e33db-1282",
"hardwareRevision":"A string representing the hardware revision.",
"name":"Endpoint name",
"location":{
"altitude":12.34,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"latitude":12.34,
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"lastModified":1469184297746,
"uncertainty":12.34,
"longitude":12.34
},
"modelNumber":"A string representing the specific model of the device.",
"softwareVersion":"A string representing the software version."
}
Complete cURL Example
The following example shows compete cURL comand that can be used to perform described operation
curl -X GET
-u <username>:<password>
http://iotserver/iot/api/v2/devices/5d81451232be-6161
Note that in the request, http://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https:// myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.