Update a Device by ID

post

/iot/api/v2/devices/{device-id}

Update device details with provided partial or complete device definition, by given device ID

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : DeviceImpl_update
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : DeviceImpl_receive
Type: object
Show Source
Nested Schema : childrenDevices
Type: object
Property description was not set
Show Source
Nested Schema : ConnectivityStatus_receive
Type: object
Show Source
Nested Schema : deviceModels
Type: array
Property description was not set
Show Source
Nested Schema : directlyConnectedOwner
Type: object
Show Source
Nested Schema : location
Type: object
Show Source
Nested Schema : Logs_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Property description was not set
Show Source
Nested Schema : resources
Type: object
Property description was not set
Show Source
Nested Schema : DeviceModelModel_receive
Type: object
Show Source
Nested Schema : actions
Type: array
Property description was not set
Show Source
Nested Schema : attributes
Type: array
Property description was not set
Show Source
Nested Schema : formatObjects
Type: array
Property description was not set
Show Source
Nested Schema : DeviceModelActionModel_receive
Type: object
Show Source
Nested Schema : arguments
Type: array
Property description was not set
Show Source
Nested Schema : DeviceModelActionArgumentModel_receive
Type: object
Show Source
Nested Schema : DeviceModelAttributeModel_receive
Type: object
Show Source
Nested Schema : MessageFormatModel_receive
Type: object
Show Source
Nested Schema : MessageFormatValue_receive
Type: object
Show Source
Nested Schema : fields
Type: array
Property description was not set
Show Source
Nested Schema : MessageFormatField_receive
Type: object
Show Source
Nested Schema : LogBuffer_receive
Type: object
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

curl -X POST 
   -u <username>:<password>
   -H 'Content-Type: application/json'
   --header "X-HTTP-Method-Override: PATCH"
   http://iotserver/iot/api/v2/devices/{device-id}

Example of Request Body

The following example shows the content of the request body in JSON format


{
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"serialNumber":"A string (which should be unique across all devices of this modelNumber/manufacturer) uniquely identifying the specific device.",
"partnerName":"Partner name",
"activationTimeAsString":"2016-07-22T10:44:57.746Z",
"softwareRevision":"A string representing the software revision.",
"description":"Endpoint description",
"enabled":false,
"manufacturer":"A string, generally an Organizationally Unique Identifier (OUI), that describes the manufacturer of the device.",
"hardwareId":"2757443c3fd0-7465",
"hardwareRevision":"A string representing the hardware revision.",
"name":"Endpoint name",
"location":{
"altitude":12.34,
"latLonString":"Property description was not set",
"origin":"ASSIGNED",
"latitude":12.34,
"geoLocationString":"Property description was not set",
"uncertainty":12.34,
"empty":false,
"longitude":12.34
},
"modelNumber":"A string representing the specific model of the device.",
"directlyConnectedOwnerId":"21b764f3136f-8b6",
"state":"REGISTERED",
"softwareVersion":"A string representing the software version."
}

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:46bf",
"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:5d8f",
"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":"120312b2304-42e9",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"69706632c8b-4723",
"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":"31653a973d03-4185",
"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":"efb3e9b374d-6607",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"de16ba3685e-424",
"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":"62136a3c594d-66a2",
"type":"INSTALL",
"ownerId":"175f462ed-33d3",
"status":"PENDING",
"errorDetails":"String with error details for current request"
},
"deviceAppId":"43f26dbd77d0-7a0a",
"installationProgress":12345,
"artifactId":"22e54ca17333-3e99",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"3c145faf3d84-6f9b",
"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:1afc",
"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:60c9",
"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:29fc",
"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:365b",
"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":"6b7b280b2aa7-2ef",
"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":"478815cd3780-1a60",
"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":"d694fbb6c03-39cc",
"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":"1140342b66cc-a9f",
"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":"64326b2d66fc-42fa",
"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":"6298e022138-3c18",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"5197103b2a17-1998",
"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":"6501166757b-288a",
"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":"7713df4c22-3767",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"appHostEndpointId":"319429823bf8-3927",
"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":"303b1d661882-1fee",
"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":"7f501d6e6565-1747",
"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":"39d91def21-355e",
"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":"627836c0632a-2774",
"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":"d18691a38f3-414"
}
],
"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":"24e1337b2216-bef",
"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":"334516757313-38bd",
"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":"48eb1d4664d2-2c4c",
"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":"23c25f7f8e1-ee4",
"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:284f",
"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:9f0",
"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":"37b86bac37a6-1948",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"1e5ef807bd0-342f",
"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":"2dbb142213f5-1311",
"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":"2f1f1349803-e37",
"string":"Raw dependency string from the artifact manifect",
"artifactId":"7c079e74186-770f",
"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":"204d4fb935cb-6353",
"type":"INSTALL",
"ownerId":"23da26f3275-1331",
"status":"PENDING",
"errorDetails":"String with error details for current request"
},
"deviceAppId":"367f3eda2c64-6d37",
"installationProgress":12345,
"artifactId":"1e2e50e2185a-18df",
"links":[
{
"rel":"self",
"href":"http://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"http://iotserver/iot/api/version/resource/path"
}
],
"id":"6fe47af13da6-1894",
"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:29e3",
"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:4352",
"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":"49e38de7cf4-7c26",
"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":"59248342b41-3128",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"description":"Endpoint description",
"appHostEndpointId":"2a5872c7ca4-798d",
"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":"43cf3eb1268e-60ab",
"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":"1914553af7-f91",
"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":"1be33fa36b17-91b",
"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":"9f8687474da-2165",
"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":"32ec316b70cc-3938"
}
],
"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":"6fe63b626ad7-40ee",
"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":"73684880715-78a8",
"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":"2fd75a6e33ea-5bcf",
"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":"255065c35611-6203",
"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":"1c301aed36f5-3dcc",
"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":"452f35f2f4d-32c4",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"74aa5d4b4e8b-5ae9",
"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":"4e1f1fe07595-e07",
"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":"199232927dc8-6c5f",
"url":"http://iotserver/iot/api/version/resource/path"
}
],
"hardwareId":"486970463442-734",
"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 POST 
   -u <username>:<password>
   -H 'Content-Type: application/json'
   --header "X-HTTP-Method-Override: PATCH"
   -d '{"metadata":{"metadata_key1":"metadata_value1","metadata_key2":"metadata_value2","metadata_key3":"metadata_value3"},"serialNumber":"A string (which should be unique across all devices of this modelNumber/manufacturer) uniquely identifying the specific device.","partnerName":"Partner name","activationTimeAsString":"2016-07-22T10:44:57.746Z","softwareRevision":"A string representing the software revision.","description":"Endpoint description","enabled":false,"manufacturer":"A string, generally an Organizationally Unique Identifier (OUI), that describes the manufacturer of the device.","hardwareId":"2757443c3fd0-7465","hardwareRevision":"A string representing the hardware revision.","name":"Endpoint name","location":{"altitude":12.34,"latLonString":"Property description was not set","origin":"ASSIGNED","latitude":12.34,"geoLocationString":"Property description was not set","uncertainty":12.34,"empty":false,"longitude":12.34},"modelNumber":"A string representing the specific model of the device.","directlyConnectedOwnerId":"21b764f3136f-8b6","state":"REGISTERED","softwareVersion":"A string representing the software version."}'
   http://iotserver/iot/api/v2/devices/5cfe48dd15a1-5be6



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.
Back to Top