1. REST API for Oracle Mobile Cloud Service
  2. Tasks
  3. Location Management

Add Devices

post

/mobile/system/locationManagement/devices

Creates one or more devices.

Permissions

Only team members with the MobileEnvironment_System role can access the Location Management API.

Request

Supported Media Types
Body ()
Root Schema : Device Items Array
Type: object
Title: Device Items Array
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 1
Array of the devices to be created.
Show Source
Nested Schema : Create Location Device
Type: object
Title: Create Location Device
The device to be created.
Show Source
Nested Schema : Attributes
Type: object
Title: Attributes
Additional Properties Allowed
Show Source
The attributes entered in the MCS UI, as key/value pairs.
Show Source
Nested Schema : Beacon
Type: object
Title: Beacon
Device's identifying information.
Match One
Show Source
Nested Schema : iBeacon
Type: object
iBeacon device.
Show Source
Nested Schema : altBeacon
Type: object
AltBeacon device.
Show Source
Nested Schema : eddystone
Type: object
Eddystone device.
Show Source
Nested Schema : eddystoneUid
Type: object
Device's UID.
Show Source
Nested Schema : eddystoneUrl
Type: object
Device's URL.
Show Source
Example Request (application/json)
{
    "items":[
        {
            "asset":333,
            "description":"Beacon on 2nd Floor in FixitFast Warehouse in Redwood City",
            "name":"RC_WH_01_F01_B006",
            "beacon":{
                "altBeacon":{
                    "id2":"AFF9",
                    "id1":"B9407F30-F5F8-466E",
                    "id3":"25556B57FE6D"
                }
            },
            "attributes":{
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status":"Active",
                "visibility":"Public",
                "manufacturer":"Abc Company"
            }
        },
        {
            "description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
            "name":"RC_WH_01_F01_B001",
            "beacon":{
                "iBeacon":{
                    "minor":"1.1",
                    "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "major":"1.0"
                }
            },
            "attributes":{
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status":"Active",
                "visibility":"Public",
                "manufacturer":"Abc Company"
            },
            "place":111
        }
    ]
}
Back to Top

Response

Supported Media Types

200 Response

The location devices were created successfully.
Body ()
Root Schema : Devices Array
Type: object
Title: Devices Array
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 1
Array of the created devices.
Show Source
Nested Schema : Location Device
Type: object
Title: Location Device
The created or updated device.
Show Source
Nested Schema : Associated Asset
Type: object
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.
Show Source
Nested Schema : Attributes
Type: object
Title: Attributes
Additional Properties Allowed
Show Source
The attributes entered in the MCS UI, as key/value pairs.
Show Source
Nested Schema : Beacon
Type: object
Title: Beacon
Device's identifying information.
Match One
Show Source
Nested Schema : Associated Place
Type: object
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.
Show Source
Nested Schema : Last Known Location
Type: object
Title: Last Known Location
Last known location of the asset.
Match One
Show Source
Nested Schema : gpsPoint
Type: object
GPS point.
Show Source
Nested Schema : iBeacon
Type: object
iBeacon device.
Show Source
Nested Schema : altBeacon
Type: object
AltBeacon device.
Show Source
Nested Schema : eddystone
Type: object
Eddystone device.
Show Source
Nested Schema : eddystoneUid
Type: object
Device's UID.
Show Source
Nested Schema : eddystoneUrl
Type: object
Device's URL.
Show Source
Nested Schema : Place's Address
Type: object
Title: Place's Address
GPS address of the place.
Match One
Show Source
Nested Schema : gpsCircle
Type: object
GPS circle.
Show Source
Nested Schema : gpsPolygon
Type: object
GPS polygon.
Show Source
Nested Schema : vertices
Type: array
Minimum Number of Items: 1
GPS polygon's vertices.
Show Source
Nested Schema : latitudeLongitudePair
Type: object
Pair of latitude and longitude values for a place.
Show Source
Example Response (application/json)
{
    "items":[
        {
            "id":11111,
            "createdOn":"2015-08-06T18:37:59.424Z",
            "modifiedOn":"2015-08-08T07:22:44.654Z",
            "asset":{
                "id":333,
                "createdOn":"2015-08-06T18:37:59.424Z",
                "modifiedOn":"2015-08-06T18:37:59.424Z",
                "lastKnownLocation":{
                    "placeId":244
                },
                "createdBy":"jdoe",
                "modifiedBy":"jdoe",
                "description":"model 1225 hospital bed",
                "name":"hospital bed #233",
                "label":"hospital bed",
                "links":[
                    {
                        "rel":"canonical",
                        "href":"/mobile/platform/location/assets/333"
                    },
                    {
                        "rel":"self",
                        "href":"/mobile/platform/location/assets/333"
                    }
                ],
                "attributes":{
                    "SJId":"6754843090",
                    "EquipmentManufacturer":"Example Company"
                }
            },
            "createdBy":"jdoe",
            "modifiedBy":"tsmith",
            "description":"Beacon on hospital bed #233 in City Hospital",
            "name":"RC_WH_01_F01_B006",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/devices/11111"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/devices/11111"
                }
            ],
            "beacon":{
                "altBeacon":{
                    "id2":"AFF9",
                    "id1":"B9407F30-F5F8-466E",
                    "id3":"25556B57FE6D"
                }
            },
            "attributes":{
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status":"Active",
                "visibility":"Public",
                "manufacturer":"Abc Company"
            }
        },
        {
            "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":"Active",
                "visibility":"Public",
                "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.

Body ()
Root Schema : Error
Type: object
Title: Error
The error JSON object returned by Mobile Cloud Service.
Show Source
Nested Schema : o:errorDetails
Type: array
Minimum Number of Items: 0
List of the issues that cause the error. Included when the error is caused by multiple issues.
Show Source
Nested Schema : Error Detail
Type: object
Title: Error Detail
Show Source
Back to Top

Examples

This example shows how to use cURL to create devices by submitting a POST request on the REST resource.

curl -i \
-X POST \ 
-u administrator@example.com:mypassword \
-d @devices.json \
-H "Content-Type: application/json; charset=utf-8" \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \
http://fif.cloud.oracle.com/mobile/system/locationManagement/devices

Examples of Request Body

Here's an example of the request body.

{
    "items" : [
        {
            "name": "RC_WH_01_F01_B001",
            "description": "Forklift beacon",
            "beacon": {
               "iBeacon" : {
                 "uid": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                 "major": "1.0",
                 "minor": "1.1"
               }
             },
            "properties" : {
                "manufacturer": "Gimbal",  
                "manufacturerId": "10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status": "Active",
                "visibility": "Public"
            }
        }
    ]
}

Example of Response Header

Here's an example of the response header:

200 OK
Content-Length: 569
Content-Type: application/json
Date: Tue, 19 Sep 2017 21:48:18 GMT

Example of Response Body

Here's an example of the response body:

{
    "items": [
        {
            "id": 33,
            "createdOn": "2017-09-21T23:34:11.526Z",
            "createdBy": "administrator",
            "modifiedOn": "2017-09-21T23:34:11.526Z",
            "modifiedBy": "administrator",
            "name": "RC_WH_01_F01_B001",
            "description": "Forklift beacon",
            "beacon": {
                "iBeacon": {
                    "major": "1.0",
                    "minor": "1.1",
                    "uuid": "B9407F30-F5F8-466E-AFF9-25556B57FE6D"
                }
            },
            "attributes": {
                "manufacturer": "Gimbal",
                "manufacturerId": "10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status": "Active",
                "visibility": "Public"
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "/mobile/platform/location/devices/33"
                },
                {
                    "rel": "self",
                    "href": "/mobile/platform/location/devices/33"
                }
            ]
        }
    ]
}
Back to Top