Store an Object by ID
/mobile/platform/storage/collections/{collection}/objects/{object}
This operation stores an object based on an identifier that you specify.
Example
The following example stores the contents of the file called myObj1.jpeg
in the collection called myCollection
. It uses the using the identifier myObj1
.
curl -X PUT -H {AUTHENTICATION HEADERS} -H "Content-Length 4321" -H "Content-Type: image/jpeg" -d @myObj1.jpeg {HOST}/mobile/platform/storage/collections/myCollection/objects/myObj1
Permissions
- Anonymous Access: If the following are true, then you can access this operation anonymously or as any user, regardless of assigned roles.
- The backend allows anonymous access.
- The
Security_CollectionsAnonymousAccess
environment policy lists the collection. - The collection is shared
- Role-Based Access:
- You must have been granted one of the following permissions to the collection:
READ_WRITE
READ_WRITE_ALL
- For role-based backends, you must have a role that enables access to the backend.
- You must have been granted one of the following permissions to the collection:
Request
- */*
-
collection: string
The name of the collection that you want to access.
When you look at the metadata for the collection, this parameter corresponds to the
id
value:{ "id": "pictures", "description": "Application images", "contentLength": 6205619, "eTag": "\"1.0\"", "links": [ { "rel": "canonical", "href": "/mobile/platform/storage/collections/images" }, { "rel": "self", "href": "/mobile/platform/storage/collections/images" } ] }
-
object: string
The ID of the object being accessed. If the object was stored via a
PUT
, then this is the ID that was provided in the URI, and if the object was stored via aPOST
, then the ID was generated and returned as part of theLocation
HTTP response header.When looking at the object metadata, this parameter corresponds to the value for the
id
attribute:{ "id": "profile-pic", "name": "Profile Picture", "contentLength": 937647, "contentType": "image/png", "eTag": "\"2\"", "createdBy": "jdoe", "createdOn": "2014-11-20T15:57:04Z", "modifiedBy": "jdoe", "modifiedOn": "2014-11-20T15:58:09Z", "links": [ { "rel": "canonical", "href": "/mobile/platform/storage/collections/pictures/objects/profile-pic" }, { "rel": "self", "href": "/mobile/platform/storage/collections/pictures/objects/profile-pic" } ] }
-
user(optional): string
This is the ID (not the user name) of a user. This query parameter allows a user with
READ_ALL
orREAD_WRITE_ALL
permission to access the isolated space of the user identified by the ID. Users who haveREAD
orREAD_WRITE
permission can access only their own space. If you storing an object in an isolated collection, and you haveREAD_ALL
orREAD_WRITE_ALL
permission, then the signed-in user is assumed unless you include this property. If you haveREAD_ALL
orREAD_WRITE_ALL
permission for an isolated collection, then you must include this property to store objects in another user's space.
-
Accept(optional): string
The media types that the client prefers for the response body. If the service doesn't support any of these types, then it returns a
406
status code, and the response body lists the media types that it supports.Examples
*/*
application/*
application/json
application/xml,application/json
-
Content-Length(optional): number
The size of the object in bytes.
-
Content-Type(optional): string
The media type of object being stored. This is the same media type that is returned when the object is requested.
-
If-Match(optional): string
The request completes successfully only if the ETag of the corresponding item matches one of the values specified in this HTTP request header.
Example - Optimistic Locking
Assume that the last time you requested an item, its ETag was
"2"
. You can use theIf-Match
HTTP request header to ensure that the operation succeeds only if the item wasn't modified after you last requested it. -
If-Modified-Since(optional): string
Date and time in HTTP-date format. The request completes successfully only if the object was modified after the date specified in this HTTP request header.
Example - Get Only if Newer
You can use this header to reduce the amount of data that you pull down to your client. For example, assume that the last time that you retrieved the object its timestamp was
Mon, 30 Jun 2014 19:43:31 GMT
. The following request retrieves the object only if the object was modified after the last time you retrieved it.curl -X GET {AUTHENTICATION HEADERS} -H 'If-Modified-Since: Mon, 30 Jun 2014 19:43:31 GMT' -d @me.jpeg {HOST}/mobile/platform/storage/collections/myCollection/objects/myObj1
-
If-None-Match(optional): string
The request completes successfully only if the ETag of the corresponding item does not match one of the values specified by this HTTP request header.
Example - Get Only if Newer
You can use this header to reduce the amount of data that gets pulled down to your client. For example, assume that the last time you accessed an item, its ETag was
"2"
. You can use theIf-None-Match
HTTP request header to ensure that the operation succeeds only if the item has been modified since you last requested it.Example - Put if Absent
When the value of the
If-None-Match
request header is a wildcard (*
), then the request succeeds only when an ETag is not present. -
If-Unmodified-Since(optional): string
Date and time in HTTP-date format. The request completes successfully only if the object wasn't modified after the date specified in this HTTP request header.
Example - Optimistic Locking
Assuming the timestamp for the last time you did a
GET
or aPUT
on the object wasMon, 30 Jun 2014 19:43:31 GMT
, you can use the this HTTP request header to ensure that the operation succeeds only if no one modified the object after that time.curl -X PUT {AUTHENTICATION HEADERS} -H 'If-Unmodified-Since: Mon, 30 Jun 2014 19:43:31 GMT' -d @myObj1.jpeg {HOST}/mobile/platform/storage/collections/myCollection/objects/myObj1
-
Oracle-Mobile-Name(optional): string
The display name for the object. If you don't include the display name, the name is set to the object identifier that the
POST
operation generates automatically or the identifier that you supplied to thePUT
operation using the{object}
path parameter.Example - With Oracle-Mobile-Name
If you include the
Oracle-Mobile-Name
header in yourPUT
request, like the following example:curl -X PUT {AUTHENTICATION HEADERS} -H "Content-Length 4321" -H "Content-Type: image/jpeg" -H "Oracle-Mobile-NAME: Banner" -d @myObj1.jpeg {HOST}/mobile/platform/storage/collections/myCollection/objects/myObj1
Then the object's name is set to to
Oracle-Mobile-Name
HTTP request header value:{ "id" : "myObj1", "name" : "Banner", "links" : { .... } }
Example - Without Oracle-Mobile-Name
If you don't include the
Oracle-Mobile-Name
header in yourPUT
request, like the following example:curl -X PUT {AUTHENTICATION HEADERS} -H "Content-Length 4321" -H "Content-Type: image/jpeg" -d @myObj1.jpeg {HOST}/mobile/platform/storage/collections/myCollection/objects/myObj1
Then the object's name will be the same value as its ID.
{ "id" : "myObj1", "name" : "myObj1", "links" : { .... } }
- */*
Response
- application/json
200 Response
OK
The object with the given identifier was replaced in the specified collection successfully .
object
Object
-
contentLength:
integer
The size of object in bytes.
-
contentType:
string
Maximum Length:
255
The media type of the object. For example, a JPEG image would have a media type of image/jpeg. -
createdBy:
string
The user name for the user who created the object.
-
createdOn:
string
The date and time, in ISO 8601 format, that the object was created (for example, 2014-06-30T01:02:03Z).
-
eTag:
string
An identifier that was assigned to this version of the object. This value changes whenever the object is updated. The value includes the starting and ending quotation marks (for example, "2"). You can use an ETag value with the `IF-MATCH` and `IF-NONE-MATCH` HTTP request headers.
-
id:
string
Minimum Length:
1
Maximum Length:1024
The object's unique identifier. This is the value that is used in the URI to access the object. -
links:
array links
Minimum Number of Items:
0
The links that you can use to explore the resource. -
modifiedBy:
string
The user name for the user who last modified the object.
-
modifiedOn:
string
The date and time, in ISO 8601 format, that the object was last modified (for example, 2014-06-30T01:02:03Z).
-
name:
string
Maximum Length:
1024
The display name for the object. -
user:
string
For user-isolated collections, the ID of the user that the object belongs to.
array
0
-
[0]:
object Link
Title:
Link
object
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
{
"modifiedOn":"2014-11-20T15:58:09Z",
"createdBy":"jdoe",
"name":"Profile Picture",
"eTag":"\"2\"",
"modifiedBy":"jdoe",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/storage/collections/pictures/profile-pic"
},
{
"rel":"self",
"href":"/mobile/platform/storage/collections/pictures/profile-pic"
}
],
"contentLength":937647,
"id":"profile-pic",
"createdOn":"2014-11-20T15:57:04Z",
"contentType":"image/png"
}
201 Response
Created
The object was created in the specified collection successfully.
object
Object
-
contentLength:
integer
The size of object in bytes.
-
contentType:
string
Maximum Length:
255
The media type of the object. For example, a JPEG image would have a media type of image/jpeg. -
createdBy:
string
The user name for the user who created the object.
-
createdOn:
string
The date and time, in ISO 8601 format, that the object was created (for example, 2014-06-30T01:02:03Z).
-
eTag:
string
An identifier that was assigned to this version of the object. This value changes whenever the object is updated. The value includes the starting and ending quotation marks (for example, "2"). You can use an ETag value with the `IF-MATCH` and `IF-NONE-MATCH` HTTP request headers.
-
id:
string
Minimum Length:
1
Maximum Length:1024
The object's unique identifier. This is the value that is used in the URI to access the object. -
links:
array links
Minimum Number of Items:
0
The links that you can use to explore the resource. -
modifiedBy:
string
The user name for the user who last modified the object.
-
modifiedOn:
string
The date and time, in ISO 8601 format, that the object was last modified (for example, 2014-06-30T01:02:03Z).
-
name:
string
Maximum Length:
1024
The display name for the object. -
user:
string
For user-isolated collections, the ID of the user that the object belongs to.
array
0
-
[0]:
object Link
Title:
Link
object
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
{
"modifiedOn":"2014-11-20T15:57:04Z",
"createdBy":"jdoe",
"name":"Profile Picture",
"eTag":"\"1\"",
"modifiedBy":"jdoe",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/storage/collections/pictures/profile-pic"
},
{
"rel":"self",
"href":"/mobile/platform/storage/collections/pictures/profile-pic"
}
],
"contentLength":937647,
"id":"profile-pic",
"createdOn":"2014-11-20T15:57:04Z",
"contentType":"image/png"
}
400 Response
Bad Request
This status is returned if you attempt to:
- Make a call without specifying the
Oracle-Mobile-Backend-ID
HTTP request header. - Specify the
user
query parameter for an endpoint that isn't an object level operation for an isolated collection. - Specify an incorrect value for a query parameter.
- Store an object with an identifier longer than the maximum allowed size.
- Store an object where the actual size of the object is different from what was specified in the
Content-Length
HTTP request header.
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:
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
-
[0]:
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.
401 Response
Unauthorized
The user is not authenticated. The request must be made with the Authorization
HTTP request header.
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:
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
-
[0]:
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.
403 Response
Forbidden
This status is returned if you attempt to:
- Make a request with a user who doesn't have a role that's associated with the backend.
- Retrieve an object without being assigned a role that has
READ
orREAD_WRITE
access for a non-anonymous collection. - Retrieve an object from your isolated space without being assigned a role that has
READ
,READ_WRITE
,READ_ALL
, orREAD_WRITE_ALL
access for the collection. - Retrieve an object from another user's isolated space without being assigned a role that has
READ_ALL
orREAD_WRITE_ALL
access for the collection. - Store an object without being assigned a role that has been granted
READ_WRITE
access for a non-anonymous collection. - Store an object to your isolated space without being assigned a role that has
READ_WRITE
orREAD_WRITE_ALL
access for the collection. - Store an object to another user's isolated space without being assigned a role that has
READ_WRITE_ALL
access for the collection.
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:
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
-
[0]:
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.
404 Response
Not Found
A collection or object with the given identifier does not exist.
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:
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
-
[0]:
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.
406 Response
Not Acceptable
The media type of the resource isn't compatible with the values in the Accept
header.
For example, you see this error when you try to request a resource that has the media type application/json
and the Accept
header value is application/xml
.
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:
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
-
[0]:
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.
409 Response
Conflict
This operation conflicted with another change made concurrently to the object.
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:
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
-
[0]:
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.
411 Response
Length Required
The PUT
or POST
HTTP request to store an object in a collection was missing either the Content-Length
or the Transfer-Encoding
header.
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:
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
-
[0]:
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.
412 Response
Precondition Failed
An object with the given identifier in the specified collection exists, but the operation failed because of one or more of the following conditions:
If-Match
If-Modified-Since
If-None-Match
If-Unmodified-Since
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:
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
-
[0]:
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.
413 Response
Request Entity Too Large
This status is returned when you attempt to store an object that is bigger than 2147483647
bytes (approx 2GB).
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:
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
-
[0]:
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
Example of Adding or Replacing an Object
This example shows how to use cURL to replace an object by submitting a PUT request on the REST resource. In this example, the object TN062415Cust43.txt
is stored in the technicianNotes
collection with the ID TN062415Cust43
. If that object exists, it's replaced by TN062415Cust43.txt
. If it doesn't exist, then it's added.
curl -i \ -X PUT \ -u mobile.user@example.com:password \ -d @TN062415Cust43.txt \ -H "Content-Type: text/plain" \ -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \ https://fif.cloud.oracle.com/mobile/platform/storage/collections/technicianNotes/objects/TN062415Cust43
Example of Updating an Object Only if it Hasn't Been Changed by Someone Else
This example shows how to use cURL to update an object only if the object wasn't updated by someone else after you originally retrieved it. In this example, the request includes the If-Match
header. The server performs the update only if the object exists and its ETag matches the ETag specified by the If-Match
header.
curl -i \ -X PUT \ -u mobile.user@example.com:password \ -d @TN062415Cust43.txt \ -H "If-Match: \"2\"" \ -H "Content-Type: text/plain" \ -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \ https://fif.cloud.oracle.com/mobile/platform/storage/collections/technicianNotes/objects/TN062415Cust43
Example of Adding an Object with a Specified ID Only if it Doesn't Exist
This example shows how to use cURL to add an object only if an object with the specified ID doesn't exist. In this example, the object TN062415Cust43.txt
is stored in the technicianNotes
collection with the ID TN062415Cust43
. The If-None-Match: *
header tells the server to perform the operation only if an object with the specified ID doesn't exist.
curl -i \ -X PUT \ -u mobile.user@example.com:password \ -d @TN062415Cust43.txt \ -H "If-None-Match: *" \ -H "Content-Type: text/plain" \ -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \ https://fif.cloud.oracle.com/mobile/platform/storage/collections/technicianNotes/objects/TN062415Cust43
Example of Response Header
Here's an example of the response header when an object is updated. In this example, an object with the ID TN062415Cust43
already exists, so the response status is 200
. If the object didn't exist, then the response status would be 201
.
200 OK Content-Length: 546 Content-Type: application/json Date: Wed, 24 Jun 2015 03:31:24 GMT
Example of Response Body
This example shows the contents of the response body in JSON format:
{ "id": "TN062415Cust43", "name": "TN062415Cust43", "contentLength": 443, "contentType": "text/plain", "eTag": "\"2\"", "createdBy": "mobileuser", "createdOn": "2015-06-24T03:30:13Z", "modifiedBy": "mobileuser", "modifiedOn": "2015-06-24T03:31:25Z", "links": [ { "rel": "canonical", "href": "/mobile/platform/storage/collections/technicianNotes/objects/TN062415Cust43" }, { "rel": "self", "href": "/mobile/platform/storage/collections/technicianNotes/objects/TN062415Cust43" } ] }