Jump to

• Request
• Response

Delete a Single Row

delete

/20190828/tables/{tableNameOrId}/rows

Delete a single row from the table, by primary key.

Request

Path Parameters

• tableNameOrId: string
  A table name within the compartment, or a table OCID.

Query Parameters

• compartmentId(optional): string
  The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
• isGetReturnRow(optional): boolean
  If true, and the operation fails due to an option setting (ifVersion et al), then the existing row will be returned.

  Default Value: false
• key: array
  Collection Format: multi

  An array of strings, each of the format "column-name:value", representing the primary key of the row.

  • [0]: string

  {
      "name":"key",
      "description":"An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
      "required":true,
      "in":"query",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• timeoutInMs(optional): integer
  Timeout setting for this operation.

  Default Value: 5000

Header Parameters

• if-match(optional): string(base64)
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  Default Value: false
• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Result of a delete operation.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DeleteRowResult

Type: object

The result of a DeleteRow operation.

Show Source

• existingValue(optional): object existingValue
  Additional Properties Allowed: additionalProperties

  The map of values from a row.
• existingVersion(optional): string(base64)
  The version string associated with the existing row. Returned if the delete fails due to options setting in the request.
• isSuccess(optional): boolean
  Convey the success or failure of the operation.
• usage(optional): object RequestUsage
  The usage metrics for a request.

{
    "description":"The result of a DeleteRow operation.",
    "properties":{
        "isSuccess":{
            "description":"Convey the success or failure of the operation.",
            "type":"boolean"
        },
        "existingVersion":{
            "description":"The version string associated with the existing row.\nReturned if the delete fails due to options setting in the\nrequest.\n",
            "type":"string",
            "format":"base64"
        },
        "existingValue":{
            "description":"The map of values from a row.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "usage":{
            "$ref":"#/definitions/RequestUsage"
        }
    }
}

Nested Schema : existingValue

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The map of values from a row.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

The map of values from a row.

Nested Schema : RequestUsage

Type: object

The usage metrics for a request.

Show Source

• readUnitsConsumed(optional): integer
  Read Units consumed by this operation.
• writeUnitsConsumed(optional): integer
  Write Units consumed by this operation.

{
    "description":"The usage metrics for a request.",
    "properties":{
        "readUnitsConsumed":{
            "type":"integer",
            "description":"Read Units consumed by this operation."
        },
        "writeUnitsConsumed":{
            "type":"integer",
            "description":"Write Units consumed by this operation."
        }
    }
}

Nested Schema : additionalProperties

Type: object

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry-after: number(float)
  A decimal number representing the number of seconds the client should wait before polling this endpoint again.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Back to Top