Delete Data

DELETE 
/v1/rdb/rest/:table

Delete data based on conditions; a WHERE clause must be provided.

Request

Path Parameters

table stringrequired

Table name

Query Parameters

select string

Fields to return, supports * or a list of specified fields

limit integer

Limit the number of deletions

order string

Sort field

Header Parameters

Prefer string

Preference settings, e.g., return=representation to return the deleted data

Responses

200

Deletion succeeded (with response body)

Response Headers

• Content-Range string

  Affected rows

• Preference-Applied string

  Applied preference settings

application/json

Schema

Schema

• Array [

object

• ]

Example (from schema)

[
  {}
]

204

Deletion succeeded (no response body)

Response Headers

• Content-Range string

  Affected rows

• Preference-Applied string

  Applied preference settings

400

Request error, e.g., missing WHERE clause

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request unique ID

Example (from schema)

{
  "code": "BadApiRequest",
  "message": "UPDATE requires a WHERE clause",
  "requestId": "req-123456"
}

Loading...