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

Remove an Object by ID

delete

/mobile/platform/storage/collections/{collection}/objects/{object}

This operation removes an object from a collection based on the object identifier.

Example

This example removes the object with identifier myObj1 that is stored in the collection myCollection.

curl -X DELETE {AUTHENTICATION HEADERS} {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
    • If the backend doesn't allow anonymous access, then you must be a member of the realm that's associated with the mobile backend.

Request

Path Parameters

  • 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"
    }
  ]
}

  • 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 a POST, then the ID was generated and returned as part of the Location 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"
    }
  ]
}
Query Parameters

  • This is the ID (not the user name) of a user. This query parameter allows a user with READ_ALL or READ_WRITE_ALL permission to access the isolated space of the user identified by the ID. Users who have READ or READ_WRITE permission can access only their own space. If you storing an object in an isolated collection, and you have READ_ALL or READ_WRITE_ALL permission, then the signed-in user is assumed unless you include this property. If you have READ_ALL or READ_WRITE_ALL permission for an isolated collection, then you must include this property to store objects in another user's space.

Header Parameters

  • 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 the If-Match HTTP request header to ensure that the operation succeeds only if the item wasn't modified after you last requested it.

  • 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

  • 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 the If-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.

  • 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 a PUT on the object was Mon, 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

Back to Top

Response

Supported Media Types

204 Response

No Content

The object was removed from the collection successfully.

Headers

400 Response

Bad Request

This status is returned if you attempt to:

  1. Make a call without specifying the Oracle-Mobile-Backend-ID HTTP request header.
  2. Specify the user query parameter for an endpoint that isn't an object level operation for an isolated collection.
  3. Specify an incorrect value for a query parameter.
  4. Store an object with an identifier longer than the maximum allowed size.
  5. Store an object where the actual size of the object is different from what was specified in the Content-Length HTTP request header.
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

401 Response

Unauthorized

The user is not authenticated. The request must be made with the Authorization HTTP request header.

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

403 Response

Forbidden

This status is returned if you attempt to:

  1. Make a request with a user from a realm that isn't associated with the mobile backend.
  2. Retrieve an object without being assigned a role that has READ or READ_WRITE access for the collection.
  3. Retrieve an object from your isolated space without being assigned a role that has READ, READ_WRITE, READ_ALL, or READ_WRITE_ALL access for the collection.
  4. Retrieve an object from another user's isolated space without being assigned a role that has READ_ALL or READ_WRITE_ALL access for the collection.
  5. Store an object without being assigned a role that has been granted READ_WRITE access for the collection.
  6. Store an object to your isolated space without being assigned a role that has READ_WRITE or READ_WRITE_ALL access for the collection.
  7. Store an object to another user's isolated space without being assigned a role that has READ_WRITE_ALL access for the collection.
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

Not Found

A collection or object with the given identifier does not exist.

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

409 Response

Conflict

This operation conflicted with another change made concurrently to the object.

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

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
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 remove an object by submitting a DELETE request on the REST resource. In this example, the collection is user-isolated, and the user making the request has read and write access for all objects (READ_WRITE_ALL role). Therefore, the user ID for the object is passed as a query parameter. 

curl -i \
-X DELETE \ 
-u mobile.user@example.com:password \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \
https://fif.cloud.oracle.com/mobile/platform/storage/collections/technicianNotes/objects/2d787219-1266-44f3-8553-72f83a2b29b6?user=8c8f1a5a-e56b-494b-9a99-f03d562c1ee7

Tip:

If you want to prevent deleting an object if someone modified it after you originally retrieved the object, include the If-Match or If-Unmodified-Since header.

Example of Response Header

Here's an example of the response header. Note that the Content-Type header shows the content type of the deleted object. 

204 NO_CONTENT
Content-Length: 0
Content-Type: text/plain
Date: Thu, 29 Mar 2018 19:04:23 GMT
Back to Top