REST API for Oracle Mobile Cloud Service

Return Assets by Query

post

/mobile/platform/location/assets/query

Call this operation to retrieve the assets that match the query parameters that you specify in the request body.

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

Supported Media Types

application/json

Root Schema : Query Parameters

Type: object

Title: Query Parameters

Show Source

associatedDeviceId(optional): integer

Return the asset associated with this device ID. When you use this query parameter, don't combine it with other parameters.
attributes(optional): object Attributes

Title: Attributes

Additional Properties Allowed: additionalProperties

The attributes entered in the MCS UI, as key/value pairs.
description(optional): string

Filter the items based on a case-insensitive partial match of this string with the asset's description.
format(optional): string

Default Value: long

Allowed Values: [ "short", "long" ]

The response is in long format by default. Specify `short` to return only the `id`, `name`, `description`, and `label` properties.
label(optional): string

Filter results based on a partial match of this string with the label.
limit(optional): integer

Minimum Value: 0

Maximum Value: 500

Default Value: 40

Maximum number of items to return (between 0 and 500). If the requested limit is greater than `500`, then `500` is substituted.
listOfAssets(optional): array listOfAssets

Asset ID(s) to search for. For example `[15,16]`.
name(optional): string

Filter results based on a case-insensitive partial match of this string with the asset's user-defined name.
offset(optional): integer

Default Value: 0

Zero-based index of the first item to return.
orderBy(optional): string

Allowed Values: [ "name", "label", "createdOn", "modifiedOn" ]

Field to order results by. Requires either `:asc` for ascending or `:desc` for descending. Example: `createdOn:asc`.
search(optional): string

Filter results based on a case-insensitive partial match of this string with either the asset's name or description.

{
    "title":"Query Parameters",
    "properties":{
        "limit":{
            "default":40,
            "minimum":0,
            "description":"Maximum number of items to return (between 0 and 500). If the requested limit is greater than `500`, then `500` is substituted.",
            "maximum":500,
            "type":"integer"
        },
        "listOfAssets":{
            "items":{
                "type":"number"
            },
            "description":"Asset ID(s) to search for. For example `[15,16]`.",
            "type":"array"
        },
        "associatedDeviceId":{
            "description":"Return the asset associated with this device ID. When you use this query parameter, don't combine it with other parameters.",
            "type":"integer"
        },
        "orderBy":{
            "description":"Field to order results by. Requires either `:asc` for ascending or `:desc` for descending. Example: `createdOn:asc`.",
            "enum":[
                "name",
                "label",
                "createdOn",
                "modifiedOn"
            ],
            "type":"string"
        },
        "search":{
            "description":"Filter results based on a case-insensitive partial match of this string with either the asset's name or description.",
            "type":"string"
        },
        "description":{
            "description":"Filter the items based on a case-insensitive partial match of this string with the asset's description.",
            "type":"string"
        },
        "name":{
            "description":"Filter results based on a case-insensitive partial match of this string with the asset's user-defined name.",
            "type":"string"
        },
        "label":{
            "description":"Filter results based on a partial match of this string with the label.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "format":{
            "default":"long",
            "description":"The response is in long format by default. Specify `short` to return only the `id`, `name`, `description`, and `label` properties.",
            "enum":[
                "short",
                "long"
            ],
            "type":"string"
        },
        "offset":{
            "default":0,
            "description":"Zero-based index of the first item to return.",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

string

{
    "title":"Attributes",
    "description":"The attributes entered in the MCS UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
    },
    "type":"object"
}

The attributes entered in the MCS UI, as key/value pairs.

Show Source

{
    "title":"Attributes",
    "description":"The attributes entered in the MCS UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
    },
    "type":"object"
}

Nested Schema : listOfAssets

Type: array

Asset ID(s) to search for. For example `[15,16]`.

Show Source

Array of: number

{
    "items":{
        "type":"number"
    },
    "description":"Asset ID(s) to search for. For example `[15,16]`.",
    "type":"array"
}

Example Request (application/json)

{
    "limit":2,
    "orderBy":"createdOn:asc",
    "search":"1225",
    "label":"bed",
    "attributes":{
        "EquipmentManufacturer":"Example Company"
    },
    "format":"long",
    "offset":0
}

Response

Supported Media Types

application/json

200 Response

The assets that matched the query parameters were retrieved successfully.

Root Schema : Query Results

Type: object

Title: Query Results

Show Source

count(optional): integer

Number of items in this response.
hasMore(optional): boolean

`true` if there are more items to return.
items(optional): array items

Minimum Number of Items: 1

Assets found.
limit(optional): integer

Limit requested.
offset(optional): integer

Offset (starting index) requested for this response.
totalResults(optional): integer

Number of items that match the query.

{
    "title":"Query Results",
    "properties":{
        "limit":{
            "description":"Limit requested.",
            "type":"integer"
        },
        "hasMore":{
            "description":"`true` if there are more items to return.",
            "type":"boolean"
        },
        "count":{
            "description":"Number of items in this response.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/assetFound"
            },
            "description":"Assets found.",
            "minItems":1,
            "type":"array"
        },
        "totalResults":{
            "description":"Number of items that match the query.",
            "type":"integer"
        },
        "offset":{
            "description":"Offset (starting index) requested for this response.",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Minimum Number of Items: 1

Assets found.

Show Source

Array of: object Asset

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.

{
    "items":{
        "$ref":"#/definitions/assetFound"
    },
    "description":"Assets found.",
    "minItems":1,
    "type":"array"
}

Nested 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

attributes(optional): object Attributes

Title: Attributes

Additional Properties Allowed: additionalProperties

The attributes entered in the MCS UI, as key/value pairs.
createdBy: string

User who added the asset.
createdOn: string

When the asset was added.
description: string

Asset's description.
devices(optional): array devices

Minimum Number of Items: 0

Devices associated with this asset. Typically one device, but there can be multiple devices.
id: number

Asset's ID.
label(optional): string

Asset's label.
lastKnownPlace(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.

{
    "title":"Asset",
    "description":"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.",
    "properties":{
        "id":{
            "description":"Asset's ID.",
            "type":"number"
        },
        "createdOn":{
            "description":"When the asset was added.",
            "type":"string"
        },
        "modifiedOn":{
            "description":"When the asset was last modified.",
            "type":"string"
        },
        "createdBy":{
            "description":"User who added the asset.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the asset.",
            "type":"string"
        },
        "description":{
            "description":"Asset's description.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the asset.",
            "type":"string"
        },
        "lastKnownPlace":{
            "$ref":"#/definitions/lastKnownLocation"
        },
        "label":{
            "description":"Asset's label.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "devices":{
            "items":{
                "$ref":"#/definitions/associatedDevice"
            },
            "description":"Devices associated with this asset. Typically one device, but there can be multiple devices.",
            "minItems":0,
            "type":"array"
        }
    },
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "type":"object"
}

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

string

{
    "title":"Attributes",
    "description":"The attributes entered in the MCS UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
    },
    "type":"object"
}

The attributes entered in the MCS UI, as key/value pairs.

Show Source

{
    "title":"Attributes",
    "description":"The attributes entered in the MCS UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
    },
    "type":"object"
}

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

Array of: object Associated Location Device

Title: Associated Location Device

The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.

{
    "items":{
        "$ref":"#/definitions/associatedDevice"
    },
    "description":"Devices associated with this asset. Typically one device, but there can be multiple devices.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Last Known Location

Type: object

Title: Last Known Location

Last known location of the asset.

Match One

Show Source

object gpsPoint

GPS point.
integer

Title: placeId

ID of the associated place.

{
    "title":"Last Known Location",
    "description":"Last known location of the asset.",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/gpsPoint"
        },
        {
            "$ref":"#/definitions/placeId"
        }
    ]
}

Nested Schema : Relationship links

Type: array

Title: Relationship links

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Link

Title: Link

{
    "title":"Relationship links",
    "items":{
        "$ref":"#/definitions/link"
    },
    "minItems":1,
    "uniqueItems":true,
    "type":"array"
}

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

attributes(optional): object Attributes

Title: Attributes

Additional Properties Allowed: additionalProperties

The 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.

{
    "title":"Associated Location Device",
    "description":"The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.",
    "properties":{
        "id":{
            "description":"Device's ID.",
            "type":"number"
        },
        "createdOn":{
            "description":"When the device was added to MCS.",
            "type":"string"
        },
        "modifiedOn":{
            "description":"When the device was last modified.",
            "type":"string"
        },
        "createdBy":{
            "description":"User who added the device.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the device.",
            "type":"string"
        },
        "description":{
            "description":"Device's description.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the device.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "beacon":{
            "$ref":"#/definitions/beacon"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        }
    },
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "type":"object"
}

Nested Schema : Beacon

Type: object

Title: Beacon

Device's identifying information.

Match One

Show Source

object iBeacon

iBeacon device.
object altBeacon

AltBeacon device.
object eddystone

Eddystone device.

{
    "title":"Beacon",
    "description":"Device's identifying information.",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/iBeacon"
        },
        {
            "$ref":"#/definitions/altBeacon"
        },
        {
            "$ref":"#/definitions/eddystone"
        }
    ]
}

Nested Schema : iBeacon

Type: object

iBeacon device.

Show Source

major(optional): string

Device's major version number.
minor(optional): string

Device's minor version number.
uuid(optional): string

Device's UUID.

{
    "description":"iBeacon device.",
    "properties":{
        "minor":{
            "description":"Device's minor version number.",
            "type":"string"
        },
        "uuid":{
            "description":"Device's UUID.",
            "type":"string"
        },
        "major":{
            "description":"Device's major version number.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : altBeacon

Type: object

AltBeacon device.

Show Source

id1(optional): string

Device's first ID.
id2(optional): string

Device's second ID.
id3(optional): string

Device's third ID.

{
    "description":"AltBeacon device.",
    "properties":{
        "id2":{
            "description":"Device's second ID.",
            "type":"string"
        },
        "id1":{
            "description":"Device's first ID.",
            "type":"string"
        },
        "id3":{
            "description":"Device's third ID.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : eddystone

Type: object

Eddystone device.

Show Source

eddystoneUid(optional): object eddystoneUid

Device's UID.
eddystoneUrl(optional): object eddystoneUrl

Device's URL.

{
    "description":"Eddystone device.",
    "properties":{
        "eddystoneUrl":{
            "description":"Device's URL.",
            "properties":{
                "url":{
                    "description":"The URL.",
                    "type":"string"
                }
            },
            "type":"object"
        },
        "eddystoneUid":{
            "description":"Device's UID.",
            "properties":{
                "instance":{
                    "description":"Individual device's ID.",
                    "type":"string"
                },
                "namespace":{
                    "description":"Namespace that the device is a member of.",
                    "type":"string"
                }
            },
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : eddystoneUid

Type: object

Device's UID.

Show Source

instance(optional): string

Individual device's ID.
namespace(optional): string

Namespace that the device is a member of.

{
    "description":"Device's UID.",
    "properties":{
        "instance":{
            "description":"Individual device's ID.",
            "type":"string"
        },
        "namespace":{
            "description":"Namespace that the device is a member of.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : eddystoneUrl

Type: object

Device's URL.

Show Source

url(optional): string

The URL.

{
    "description":"Device's URL.",
    "properties":{
        "url":{
            "description":"The URL.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : gpsPoint

Type: object

GPS point.

Show Source

latitude(optional): number

GPS point's latitude
longitude(optional): number

GPS point's longitude.

{
    "description":"GPS point.",
    "properties":{
        "longitude":{
            "description":"GPS point's longitude.",
            "type":"number"
        },
        "latitude":{
            "description":"GPS point's latitude",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : Link

Type: object

Title: Link

Show Source

href: string

A relative URL.
rel:

Allowed Values: [ "self", "canonical", "prev", "next" ]

The type of link.

{
    "title":"Link",
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "limit":2,
    "hasMore":true,
    "count":2,
    "items":[
        {
            "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"
            },
            "devices":[
                {
                    "id":3401,
                    "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/3401"
                        },
                        {
                            "rel":"self",
                            "href":"/mobile/platform/location/devices/3401"
                        }
                    ],
                    "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"
                    }
                }
            ]
        },
        {
            "id":888,
            "createdOn":"2015-10-16T09:24:41.354Z",
            "modifiedOn":"2015-10-16T09:24:41.354Z",
            "lastKnownLocation":{
                "placeId":360
            },
            "createdBy":"jdoe",
            "modifiedBy":"jdoe",
            "description":"model 1225 hospital bed",
            "name":"hospital bed #233",
            "label":"hospital bed",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/assets/888"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/assets/888"
                }
            ],
            "attributes":{
                "SJId":"6754843090",
                "EquipmentManufacturer":"Example Company"
            },
            "devices":[
                {
                    "id":648,
                    "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/648"
                        },
                        {
                            "rel":"self",
                            "href":"/mobile/platform/location/devices/648"
                        }
                    ],
                    "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"
                    }
                }
            ]
        }
    ],
    "totalResults":32,
    "offset":0
}

400 Response

The request failed because the JSON payload for the query is not well-formed, or because an exception occurred during processing.

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

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

Array of: object Error Detail

Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

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.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Examples

This example shows how to use cURL to retrieve information about assets by submitting a POST request on the REST resource.

curl -i \
-X POST \ 
-u mobile.user@example.com:password \
-d @assets.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/platform/location/assets/query

Example of Request Body

Here's an example of the request body in JSON format. This example requests, in ascendingcreatedOn order, information about assets where the label includes the string bed, the EquipmentManufacturer attribute is Example Company, and either the name or description contains the string 1225 (case-insensitive matches). This request asks for the first two search results. If you subsequently want to get the next set of assets, starting with the third asset, you would send another request with the offset set to 2. Note that it is requesting the long format of the response body. If the value was short, then the response body would include id, name, description, and label only.

{
    "label":"bed",
    "attributes":{
        "EquipmentManufacturer":"Example Company"
    },
    "orderBy":"createdOn:asc",
    "offset":0,
    "limit":2,
    "format":"long",
    "search":"1225"
}

Example of Response Header

Here's an example of the response header:

200 OK
Content-Length: 1081
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:

{
    "items":[
        {
            "devices":[
                {
                    "id":3401,
                    "createdBy":"jdoe",
                    "name":"RC_WH_01_F01_B001",
                    "createdOn":"2015-08-06T18:37:59.424Z",
                    "modifiedOn":"2015-08-08T07:22:44.654Z",
                    "beacon":{
                        "iBeacon":{
                            "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                            "major":"1.0",
                            "minor":"1.1"}},
                    "modifiedBy":"tsmith",
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"/mobile/platform/location/devices/3401"},
                        {
                            "rel":"self",
                            "href":"/mobile/platform/location/devices/3401"}
                    ],
                    "attributes":{
                        "manufacturer":"Example Company",
                        "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                        "status":"Active",
                        "visibility":"Public"},
                    "description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City"}
            ],
            "label":"hospital bed",
            "lastKnownLocation":{
                "placeId":244},
            "id":333,
            "createdBy":"jdoe",
            "name":"hospital bed #233",
            "createdOn":"2015-08-06T18:37:59.424Z",
            "modifiedOn":"2015-08-06T18:37:59.424Z",
            "modifiedBy":"jdoe",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/assets/333"},
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/assets/333"}
            ],
            "attributes":{
                "EquipmentManufacturer":"Example Company",
                "SJId":"6754843090"},
            "description":"model 1225 hospital bed"},
        {
            "devices":[
                {
                    "id":648,
                    "createdBy":"jdoe",
                    "name":"RC_WH_01_F01_B001",
                    "createdOn":"2015-08-06T18:37:59.424Z",
                    "modifiedOn":"2015-08-08T07:22:44.654Z",
                    "beacon":{
                        "iBeacon":{
                            "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                            "major":"1.0",
                            "minor":"1.1"}},
                    "modifiedBy":"tsmith",
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"/mobile/platform/location/devices/648"},
                        {
                            "rel":"self",
                            "href":"/mobile/platform/location/devices/648"}
                    ],
                    "attributes":{
                        "manufacturer":"Example Company",
                        "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                        "status":"Active",
                        "visibility":"Public"},
                    "description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City"}
            ],
            "label":"hospital bed",
            "lastKnownLocation":{
                "placeId":360},
            "id":888,
            "createdBy":"jdoe",
            "name":"hospital bed #233",
            "createdOn":"2015-10-16T09:24:41.354Z",
            "modifiedOn":"2015-10-16T09:24:41.354Z",
            "modifiedBy":"jdoe",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/assets/888"},
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/assets/888"}
            ],
            "attributes":{
                "EquipmentManufacturer":"Example Company",
                "SJId":"6754843090"},
            "description":"model 1225 hospital bed"}
    ],
    "totalResults":32,
    "offset":0,
    "limit":2,
    "count":2,
    "hasMore":true
}