Jump to

• Request
• Response

Delete a Row with a 1-Column Key

delete

/mobile/platform/database/objects/{table}/{id}

Deletes the row identified by the one-column primary key.

For security reasons, you can call this operation only from custom API implementations by using the custom code SDK. You can't make direct requests from client applications. This API is included in this reference merely to describe the request and response bodies for the custom code SDK calls.

Request

Path Parameters

• id: string

  The primary key of the table.

  If the primary key is composed of more than one column, then each column in the primary key must be provided in sequence, and the sequence must match the order of the columns in the Oracle-Mobile-Primary-Keys header when the table was implicitly or explicitly created. For example, if the primary key is the title and the year, then the URI might be /mobile/system/database/Movies/Annie/2014. Note that when you use the Database Access operations to work with the table data, you'll need to know the order of the primary keys that you used when you created (or re-created) the table. However, when you call either GET /mobile/system/databaseManagement/tables or GET /mobile/system/databaseManagement/tables/{table}, the primaryKeys property lists the columns in alphabetical order, and not in the order that you used when you created or re-created the table. Therefore, you must make a note of the order when you create or re-create a table.

• table: string
  The name of the database table.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The structure of the response JSON object depends on if the table has a primary key:

Example when the table has a primary key:

{ "rowCount" : 2 } 

Example when the row key is the id column:

{"items":[{"id":42},{"id":43}]} 

Body ()

Root Schema : Add, Update, or Delete Response

Type: object

Title: Add, Update, or Delete Response

Match One

Show Source

• object Row Count
  Title: Row Count
• object Added, Updated, or Deleted Items
  Title: Added, Updated, or Deleted Items

  IDs for the rows that were added, updated, or deleted.

{
    "title":"Add, Update, or Delete Response",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/rowCount"
        },
        {
            "$ref":"#/definitions/idItems"
        }
    ]
}

Nested Schema : Row Count

Type: object

Title: Row Count

Show Source

• rowCount: integer
  Number of rows added, updated, or deleted

{
    "title":"Row Count",
    "properties":{
        "rowCount":{
            "description":"Number of rows added, updated, or deleted",
            "type":"integer"
        }
    },
    "required":[
        "rowCount"
    ],
    "type":"object"
}

Nested Schema : Added, Updated, or Deleted Items

Type: object

Title: Added, Updated, or Deleted Items

IDs for the rows that were added, updated, or deleted.

Show Source

• items: array Row Data
  Title: Row Data

  Minimum Number of Items: 0

  Unique Items Required: true

{
    "title":"Added, Updated, or Deleted Items",
    "description":"IDs for the rows that were added, updated, or deleted.",
    "properties":{
        "items":{
            "$ref":"#/definitions/idRowData"
        }
    },
    "required":[
        "items"
    ],
    "type":"object"
}

Nested Schema : Row Data

Type: array

Title: Row Data

Minimum Number of Items: 0

Unique Items Required: true

Show Source

• Array of: object ID
  Title: ID

{
    "title":"Row Data",
    "items":{
        "$ref":"#/definitions/idData"
    },
    "minItems":0,
    "uniqueItems":true,
    "type":"array"
}

Nested Schema : ID

Type: object

Title: ID

Show Source

• id(optional): integer
  Value of the `id` column.

{
    "title":"ID",
    "properties":{
        "id":{
            "description":"Value of the `id` column.",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top