Add Assets from File
/mobile/system/locationManagement/assets/upload
Adds the assets that are defined in a file in CSV format.
The CSV format is:
name,description,label,attributeKey1=attributeValue1,attributeKey2=attributeValue2
The attributeKey=attributeValue
value is optional, and you can have multiple attributeKey=attributeValue
values separated by a ,
(comma).
For example:
#version=1.0
hospital bed #233,model 1225 hospital bed,hospital bed,EquipmentManufacturer=Example Company,SJId=6754843090
Permissions
Only team members with the Administrator
role can access the Location Management API.
Request
- binary/octet-stream
- binary/octet-stream
Response
- application/json
200 Response
object
Asset Items Array
-
items(optional):
array items
Minimum Number of Items:
1
Array of the created assets.
array
1
-
Array of:
object Asset
Title:
Asset
The created or updated asset.
object
Asset
-
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the 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
The devices that are associated with this asset. Typically one device, but there can be multiple associated devices. -
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
array
0
-
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.
object
Last Known Location
array
Relationship links
1
true
-
Array of:
object Link
Title:
Link
object
Associated Location Device
-
attributes(optional):
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the 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.
-
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.
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.
object
-
latitude(optional):
number
GPS point's latitude
-
longitude(optional):
number
GPS point's longitude.
object
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
{
"items":[
{
"modifiedOn":"2015-08-06T18:37:59.424Z",
"createdBy":"jdoe",
"name":"hospital bed #233",
"description":"model 1225 hospital bed",
"modifiedBy":"jdoe",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/location/assets/333"
},
{
"rel":"self",
"href":"/mobile/platform/location/assets/333"
}
],
"attributes":{
"SJId":"6754843090",
"EquipmentManufacturer":"Example Company"
},
"label":"hospital bed",
"id":333,
"createdOn":"2015-08-06T18:37:59.424Z"
}
]
}
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
The service's error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
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
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's 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 create assets from a CSV file by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X POST -u administrator@example.com:password --data-binary @assets.csv -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/assets/upload
Examples of Request Body
The following shows an example of the upload file.
#version=1.0
fl7,KM forklift,Forklift #7,capacity=3000lbs
Example of Response Header
The following shows an example of the response header:
200 OK Content-Length: 400 Content-Type: application/json Date: Tue, 19 Sep 2017 21:48:18 GMT
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"id": 34,
"createdOn": "2017-09-19T22:45:13.740Z",
"createdBy": "administrator",
"modifiedOn": "2017-09-19T22:45:13.740Z",
"modifiedBy": "administrator",
"name": "fl7",
"label": "Forklift #7",
"description": "KM forklift",
"lastKnownLocation": null,
"attributes": {
"capacity": "3000lbs"
},
"links": [
{
"rel": "canonical",
"href": "/mobile/platform/location/assets/34"
},
{
"rel": "self",
"href": "/mobile/platform/location/assets/34"
}
]
}
]
}