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

Return an Asset by Name

get

/mobile/platform/location/assets

Retrieves the location asset that matches the query parameter name.

Permissions

You can access this operation as a social user, a virtual user, an anonymous user, or a mobile user. If you access this operation as a mobile user, then you must be a member of the realm that's associated with the mobile backend.

Request

Query Parameters

  • The name of the asset to be returned. This name must be an existing asset name.

Back to Top

Response

Supported Media Types

200 Response

The asset was retrieved successfully.
Body ()
Root Schema : Asset
Type: object
Title: Asset
The long format includes all properties. The short format contains only `id`, `name`, `description`, and `label`. The short format applies to `POST /mobile/platform/location/assets` responses only.
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 : devices
Type: array
Minimum Number of Items: 0
Devices associated with this asset. Typically one device, but there can be multiple devices.
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 : Associated Location Device
Type: object
Title: Associated Location Device
The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.
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
Nested Schema : gpsPoint
Type: object
GPS point.
Show Source
Example Response (application/json)
{
    "id":111,
    "createdOn":"2015-08-06T18:37:59.424Z",
    "modifiedOn":"2015-08-06T18:37:59.424Z",
    "lastKnownLocation":{
        "gpsPoint":{
            "longitude":-121.1566,
            "latitude":37.5548
        }
    },
    "createdBy":"jdoe",
    "modifiedBy":"jdoe",
    "description":"Forklift in the FixItFast Warehouse in Redwood City",
    "name":"FL3256 series 2 #13",
    "label":"forklift",
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/platform/location/assets/111"
        },
        {
            "rel":"self",
            "href":"/mobile/platform/location/assets/111"
        }
    ],
    "attributes":{
        "EquipmentManufacturer":"Abc Company",
        "beaconID":"AE2924505-66045"
    },
    "devices":[
        {
            "id":345,
            "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/345"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/devices/345"
                }
            ],
            "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"
            }
        }
    ]
}

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

404 Response

Asset ID not found.

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 retrieve information about an asset by submitting a GET request on the REST resource.

curl -i \
-X GET \ 
-u mobile.user@example.com:password \
-H "Content-Type: application/json; charset=utf-8" \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \
https://fif.cloud.oracle.com/mobile/platform/location/assets?name=RC_WH_01_F01_B023

Example of Response Header

Here's an example of the response header:

200 OK
Content-Length: 1836
Content-Type: application/json
Date: Tue, 16 Jun 2015 01:39:07 GMT

Example of Response Body

This example shows the contents of the response body in JSON format:

{
   "id":111,
   "createdOn":"2015-08-06T18:37:59.424Z",
   "createdBy":"jdoe",
   "modifiedOn":"2015-08-06T18:37:59.424Z",
   "modifiedBy":"jdoe",
   "name":"RC_WH_01_F01_B023",
   "label":"forklift",
   "description":"Forklift in the FixItFast Warehouse in Redwood City",
   "lastKnownLocation":{
      "gpsPoint":{
         "latitude":37.5548,
         "longitude":-121.1566
      }
   },
   "devices":[
      {
         "id":345,
         "createdOn":"2015-08-06T18:37:59.424Z",
         "createdBy":"jdoe",
         "modifiedOn":"2015-08-08T07:22:44.654Z",
         "modifiedBy":"tsmith",
         "name":"RC_WH_01_F01_B001",
         "description":"Beacon in FixitFast Warehouse in Redwood City",
         "beacon":{
            "iBeacon":{
               "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
               "major":"1.0",
               "minor":"1.1"
            }
         },
         "attributes":{
            "manufacturer":"Abc Company",
            "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
            "status":"Active",
            "visibility":"Public"
         },
         "links":[
            {
               "rel":"canonical",
               "href":"/mobile/platform/location/devices/345"
            },
            {
               "rel":"self",
               "href":"/mobile/platform/location/devices/345"
            }
         ]
      }
   ],
   "attributes":{
      "EquipmentManufacturer":"Abc Company",
      "beaconID":"AE2924505-66045"
   },
   "links":[
      {
         "rel":"canonical",
         "href":"/mobile/platform/location/assets/111"
      },
      {
         "rel":"self",
         "href":"/mobile/platform/location/assets/111"
      }
   ]
}
Back to Top