Jump to

• Request
• Response

Write a Single Row

put

/20190828/tables/{tableNameOrId}/rows

Write a single row into the table.

Request

Path Parameters

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

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.

Body ()

Specifications for the putting of a table row.

Root Schema : UpdateRowDetails

Type: object

Specifications for the putting of a table row.

Show Source

• compartmentId(optional): string
  The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.
• identityCacheSize(optional): integer
  Sets the number of generated identity values that are requested from the server during a put. If present and greater than 0, this value takes precedence over a default value for the table.
• isExactMatch(optional): boolean
  If present and true, the presented row value must exactly match the table's schema. Otherwise, rows with missing non-key fields or extra fields can be written successfully.
• isGetReturnRow(optional): boolean
  Default Value: false

  If true, and the put fails due to an option setting, then the existing row will be returned.
• isTtlUseTableDefault(optional): boolean
  Default Value: true

  If true, set time-to-live for this row to the table's default.
• option(optional): string
  Allowed Values: [ "IF_ABSENT", "IF_PRESENT" ]

  Specifies a condition for the put operation.
• timeoutInMs(optional): integer
  Default Value: 5000

  Timeout setting for the put.
• ttl(optional): integer
  Time-to-live for the row, in days.
• value: object value
  Additional Properties Allowed: additionalProperties

  The map of values from a row.

{
    "description":"Specifications for the putting of a table row.",
    "required":[
        "value"
    ],
    "properties":{
        "compartmentId":{
            "description":"The OCID of the table's compartment.  Required\nif the tableNameOrId path parameter is a table name.\nOptional if tableNameOrId is an OCID.  If tableNameOrId\nis an OCID, and compartmentId is supplied, the latter\nmust match the identified table's compartmentId.\n",
            "type":"string"
        },
        "value":{
            "description":"The map of values from a row.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "option":{
            "description":"Specifies a condition for the put operation.",
            "type":"string",
            "enum":[
                "IF_ABSENT",
                "IF_PRESENT"
            ]
        },
        "isGetReturnRow":{
            "description":"If true, and the put fails due to an option setting, then\nthe existing row will be returned.\n",
            "type":"boolean",
            "default":false
        },
        "timeoutInMs":{
            "description":"Timeout setting for the put.",
            "type":"integer",
            "default":5000
        },
        "ttl":{
            "description":"Time-to-live for the row, in days.",
            "type":"integer"
        },
        "isTtlUseTableDefault":{
            "description":"If true, set time-to-live for this row to the table's default.\n",
            "type":"boolean",
            "default":true
        },
        "identityCacheSize":{
            "description":"Sets the number of generated identity values that are\nrequested from the server during a put. If present and greater than 0,\nthis value takes precedence over a default value for the table.\n",
            "type":"integer"
        },
        "isExactMatch":{
            "description":"If present and true, the presented row value must exactly\nmatch the table's schema.  Otherwise, rows with missing\nnon-key fields or extra fields can be written successfully.\n",
            "type":"boolean"
        }
    }
}

Nested Schema : value

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 : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Result of a put operation.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : UpdateRowResult

Type: object

The result of an UpdateRow 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 put fails due to options setting in the request.
• generatedValue(optional): string
  The value generated if the operation created a new value for an identity column. If the table has no identity column, this value is null. If it has an identity column, and a value was generated for that column, it is non-null.
• usage(optional): object RequestUsage
  The usage metrics for a request.
• version(optional): string(base64)
  An opaque version string associated with the row.

{
    "description":"The result of an UpdateRow operation.",
    "properties":{
        "version":{
            "description":"An opaque version string associated with the row.",
            "type":"string",
            "format":"base64"
        },
        "existingVersion":{
            "description":"The version string associated with the existing row.\nReturned if the put 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"
            }
        },
        "generatedValue":{
            "description":"The value generated if the operation created a new value for\nan identity column. If the table has no identity column, this value\nis null. If it has an identity column, and a value was generated for\nthat column, it is non-null.\n",
            "type":"string"
        },
        "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