Update Device
/mobile/system/locationManagement/devices/{id}
Updates the device that matches the ID.
Permissions
Only team members with the MobileEnvironment_System
role can access the Location Management API.
Request
- application/json
-
id: integer
The ID of the device. This ID must be an existing device ID.
object
Update Location Device
-
asset(optional):
number
The asset ID that contains the device. A device can be associated with a place or asset, but not both.
-
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the MCS UI, as key/value pairs. -
beacon(optional):
object Beacon
Title:
Beacon
Device's identifying information. -
description(optional):
string
Device's description.
-
name(optional):
string
User-defined name for the device.
-
place(optional):
number
The place ID that contains the device. A device can be associated with a place or asset, but not both.
object
Attributes
object
Beacon
object
-
major(optional):
string
Device's major version number.
-
minor(optional):
string
Device's minor version number.
-
uuid(optional):
string
Device's UUID.
object
-
id1(optional):
string
Device's first ID.
-
id2(optional):
string
Device's second ID.
-
id3(optional):
string
Device's third ID.
object
-
eddystoneUid(optional):
object eddystoneUid
Device's UID.
-
eddystoneUrl(optional):
object eddystoneUrl
Device's URL.
object
-
instance(optional):
string
Individual device's ID.
-
namespace(optional):
string
Namespace that the device is a member of.
{
"attributes":{
"status":"InActive",
"visibility":"Private"
}
}
Response
- application/json
200 Response
object
Location Device
-
asset(optional):
object Associated Asset
Title:
Associated Asset
The properties for an associated asset. This object doesn't include the `devices` property because the associated device is the containing object. -
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the MCS UI, as key/value pairs. -
beacon(optional):
object Beacon
Title:
Beacon
Device's identifying information. -
createdBy:
string
User who added the device.
-
createdOn:
string
When the device was added to MCS.
-
description:
string
Device's description.
-
id:
number
Device's ID.
-
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy(optional):
string
User who last modified the device.
-
modifiedOn(optional):
string
When the device was last modified.
-
name:
string
User-defined name for the device.
-
place(optional):
object Associated Place
Title:
Associated Place
The properties for an associated place. This object doesn't include the `devices` property because the associated device is the containing object.
object
Associated Asset
-
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the MCS UI, as key/value pairs. -
createdBy:
string
User who added the asset.
-
createdOn:
string
When the asset was added to MCS.
-
description:
string
Asset's description.
-
id:
number
Asset's ID.
-
label(optional):
string
Asset's label.
-
lastKnownLocation(optional):
object Last Known Location
Title:
Last Known Location
Last known location of the asset. -
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy(optional):
string
User who last modified the asset.
-
modifiedOn(optional):
string
When the asset was last modified.
-
name:
string
User-defined name for the asset.
object
Attributes
object
Beacon
array
Relationship links
1
true
-
Array of:
object Link
Title:
Link
object
Associated Place
-
address(optional):
object Place's Address
Title:
Place's Address
GPS address of the place. -
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the MCS UI, as key/value pairs. -
createdBy:
string
User who added the place.
-
createdOn:
string
When the place was added to MCS.
-
description:
string
Place's description.
-
hasChildren(optional):
boolean
Set to `true` if this place is a parent of other places.
-
id:
number
Place's ID.
-
label(optional):
string
Place's label.
-
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy(optional):
string
User who last modified the place.
-
modifiedOn(optional):
string
When the place was last modified.
-
name:
string
User-defined name for the place.
-
parentPlace(optional):
number
Place's parent place.
object
Last Known Location
object
-
latitude(optional):
number
GPS point's latitude
-
longitude(optional):
number
GPS point's longitude.
object
-
major(optional):
string
Device's major version number.
-
minor(optional):
string
Device's minor version number.
-
uuid(optional):
string
Device's UUID.
object
-
id1(optional):
string
Device's first ID.
-
id2(optional):
string
Device's second ID.
-
id3(optional):
string
Device's third ID.
object
-
eddystoneUid(optional):
object eddystoneUid
Device's UID.
-
eddystoneUrl(optional):
object eddystoneUrl
Device's URL.
object
-
instance(optional):
string
Individual device's ID.
-
namespace(optional):
string
Namespace that the device is a member of.
object
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
object
Place's Address
object
-
latitude(optional):
number
Latitude of the center of the GPS circle.
-
longitude(optional):
number
Longitude of the center of the GPS circle.
-
radius(optional):
number
GPS circle's radius in meters.
object
-
vertices(optional):
array vertices
Minimum Number of Items:
1
GPS polygon's vertices.
array
1
-
Array of:
object latitudeLongitudePair
Pair of latitude and longitude values for a place.
object
-
latitude(optional):
number
Place's latitude.
-
longitude(optional):
number
Place's longitude.
{
"id":12345,
"createdOn":"2015-08-06T18:37:59.424Z",
"modifiedOn":"2015-08-08T07:22:44.654Z",
"createdBy":"jdoe",
"modifiedBy":"tsmith",
"description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
"name":"RC_WH_01_F01_B001",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/location/devices/12345"
},
{
"rel":"self",
"href":"/mobile/platform/location/devices/12345"
}
],
"beacon":{
"iBeacon":{
"minor":"1.1",
"uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
"major":"1.0"
}
},
"attributes":{
"manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
"status":"InActive",
"visibility":"Private",
"manufacturer":"Abc Company"
},
"place":{
"id":111,
"createdOn":"2015-08-06T18:37:59.424Z",
"modifiedOn":"2015-08-06T18:37:59.424Z",
"createdBy":"jdoe",
"address":{
"gpsPoint":{
"longitude":-121.1566,
"latitude":37.5548
}
},
"modifiedBy":"jdoe",
"description":"FixitFast Warehouse in Redwood City",
"name":"FixitFast Redwood City Warehouse",
"label":"FixitFast Warehouse",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/location/places/111"
},
{
"rel":"self",
"href":"/mobile/platform/location/places/111"
}
],
"attributes":{
"equipmentManufacturer":"Abc Corp"
},
"parentPlace":42
}
}
400 Response
Bad request.
object
Error
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
List of the issues that cause the error. Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
array
0
-
Array of:
object Error Detail
Title:
Error Detail
object
Error Detail
-
instance:
string
The URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
404 Response
Device ID not found.
object
Error
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
List of the issues that cause the error. Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
array
0
-
Array of:
object Error Detail
Title:
Error Detail
object
Error Detail
-
instance:
string
The URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
Mobile Cloud Service error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Examples
The following example shows how to update a device by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X PUT -u administrator@example.com:mypassword -d update.json -H "Content-Type: application/json; charset=utf-8" -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" https://fif.cloud.oracle.com/mobile/system/locationManagement/devices/32
Example of Request Body
The following example shows the contents of the request body. This example associates the device with a place and changes its status.
{ "place": 51, "properties": { "status": "Active" } }
Example of Response Header
The following shows an example of the response header.
200 OK Content-Length: 955 Content-Type: application/json Date: Fri, 22 Sep 2017 00:08:29 GMT
Example of Response Body
The following example shows, in JSON format, the contents of the response body with the new status and associated place:
{
"id": 32,
"createdOn": "2017-09-21T23:29:41.903Z",
"createdBy": "administrator",
"modifiedOn": "2017-09-22T00:28:08.930Z",
"modifiedBy": "administrator",
"name": "RC_WH_01_F01_B002",
"description": "iBeacon",
"place": {
"id": 51,
"createdOn": "2017-09-21T23:19:53.045Z",
"createdBy": "administrator",
"modifiedOn": "2017-09-21T23:19:53.045Z",
"modifiedBy": "administrator",
"name": "entranceSouth",
"label": "public access",
"description": "South Entrance New City",
"hasChildren": false,
"address": {
"gpsPoint": {
"longitude": -121.7845,
"latitude": 37.845
}
},
"attributes": {
"guardStation": "true"
},
"links": [
{
"rel": "canonical",
"href": "/mobile/platform/location/places/51"
},
{
"rel": "self",
"href": "/mobile/platform/location/places/51"
}
]
},
"beacon": {
"iBeacon": {
"major": "1.0",
"minor": "1.1",
"uuid": "B9407F30-F5F8-466E-AFF9-25556B57AB1D"
}
},
"attributes": {
"status": "Active",
"manufacturer": "Gimbal"
},
"links": [
{
"rel": "canonical",
"href": "/mobile/platform/location/devices/32"
},
{
"rel": "self",
"href": "/mobile/platform/location/devices/32"
}
]
}