REST API for Oracle Query Service

Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Preview object data

post

/20210831/projects/{projectId}/n/{namespace}/b/{bucketName}/o/{objectName}/actions/previewObject

Get Object Preview, the first 10 rows from Object.

Request

Path Parameters

bucketName: string

Minimum Length: 1

Maximum Length: 255

The name of Object Store bucket
namespace: string

Minimum Length: 1

Maximum Length: 255

The name of Object Store namespace
objectName: string

Minimum Length: 1

Maximum Length: 255

The name of object
projectId: string

Minimum Length: 1

Maximum Length: 255

The OCID of Query Service project

Header Parameters

opc-request-id: string

The client request ID for tracing.

Details for tweaking of object preview. Provided parameters can influence how the rows and fields are parsed for the preview.

Root Schema : PreviewObjectDetails

Type: object

Details for tweaking of object preview. Provided parameters can influence how the rows and fields are parsed for the preview.

Show Source

csvFormattingDetails(optional): object CsvFormattingDetails

Preview formatting details specific to objects in the CSV format.

{
    "type":"object",
    "description":"Details for tweaking of object preview. Provided parameters can influence\nhow the rows and fields are parsed for the preview.\n",
    "properties":{
        "csvFormattingDetails":{
            "$ref":"#/definitions/CsvFormattingDetails"
        }
    }
}

Nested Schema : CsvFormattingDetails

Type: object

Preview formatting details specific to objects in the CSV format.

Show Source

areBlankAsNull(optional): boolean

Default Value: true

When set to true, loads fields consisting of spaces as null.
areIgnoreBlankLines(optional): boolean

Default Value: true

Blank lines are ignored when set to true.
areRemoveQuotes(optional): boolean

Default Value: true

Removes any quotes that are around any field in the source file.
areTrimSpaces(optional): string

Default Value: LDRTRIM

Allowed Values: [ "RTRIM", "LTRIM", "NOTRIM", "LRTRIM", "LDRTRIM" ]

Specifies how the leading and trailing spaces of the fields are trimmed.
areTruncateColumn(optional): boolean

Default Value: true

If the data in the file is too long for a field, then this option will truncate the value of the field rather than reject the row.
conversionErrorsType(optional): string

Allowed Values: [ "REJECT_RECORD", "STORE_NULL" ]

If a row is rejected because of data type conversion errors, the related columns are stored as null or the row is rejected.
dateFormat(optional): string

Minimum Length: 1

Maximum Length: 255

Specifies the date format in the source file. See the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html

Example: MM-DD-YYYYBC MM-DD-YYYY YYYYMMDD HHMISS YYMMDD HHMISS YYYY.DDD YYYY-MM-DD
delimiterCharacter(optional): string

Minimum Length: 1

Maximum Length: 1

Specifies the field delimiter character.
isEscape(optional): boolean

Default Value: true

The character '\' is used as the escape character when specified.
quoteCharacter(optional): string

Minimum Length: 1

Maximum Length: 1

Specifies the quote character for the fields, the quote characters are removed during loading when specified.
rejectLimit(optional): integer(int32)

Maximum Value: 1000

The operation will error out after specified number of rows are rejected.
skipHeadersLimit(optional): integer(int32)

Maximum Value: 10

Specifies how many rows should be skipped from the start of the file.
timestampFormat(optional): string

Minimum Length: 1

Maximum Length: 255

Specifies the timestamp format in the source file. See the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html

Example: YYYY-MM-DD HH:MI:SS.FF YYYY-MM-DD HH:MI:SS.FF3 MM/DD/YYYY HH:MI:SS.FF3
timestampLocalTimeZoneFormat(optional): string

Minimum Length: 1

Maximum Length: 255

Specifies the timestamp with local timezone format in the source file. See the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html

Example: DD Mon YYYY HH:MI:SS.FF TZR MM/DD/YYYY HH:MI:SS.FF TZR YYYY-MM-DD HH:MI:SS+/-TZR YYYY-MM-DD HH:MI:SS.FF3 DD.MM.YYYY HH:MI:SS TZR
timestampTimeZoneFormat(optional): string

Minimum Length: 1

Maximum Length: 255

Specifies the timestamp with timezone format in the source file. See the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html

Example: DD Mon YYYY HH:MI:SS.FF TZR MM/DD/YYYY HH:MI:SS.FF TZR YYYY-MM-DD HH:MI:SS+/-TZR YYYY-MM-DD HH:MI:SS.FF3 DD.MM.YYYY HH:MI:SS TZR

{
    "type":"object",
    "description":"Preview formatting details specific to objects in the CSV format.\n",
    "properties":{
        "areBlankAsNull":{
            "type":"boolean",
            "description":"When set to true, loads fields consisting of spaces as null.\n",
            "default":true
        },
        "conversionErrorsType":{
            "description":"If a row is rejected because of data type conversion errors,\nthe related columns are stored as null or the row is rejected.\n",
            "type":"string",
            "enum":[
                "REJECT_RECORD",
                "STORE_NULL"
            ]
        },
        "dateFormat":{
            "description":"Specifies the date format in the source file.\nSee the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html\n",
            "example":"MM-DD-YYYYBC\nMM-DD-YYYY\nYYYYMMDD HHMISS\nYYMMDD HHMISS\nYYYY.DDD\nYYYY-MM-DD\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "delimiterCharacter":{
            "description":"Specifies the field delimiter character.\n",
            "type":"string",
            "minLength":1,
            "maxLength":1
        },
        "isEscape":{
            "description":"The character '\\' is used as the escape character when specified.\n",
            "type":"boolean",
            "default":true
        },
        "areIgnoreBlankLines":{
            "description":"Blank lines are ignored when set to true.\n",
            "type":"boolean",
            "default":true
        },
        "quoteCharacter":{
            "description":"Specifies the quote character for the fields,\nthe quote characters are removed during loading when specified.\n",
            "type":"string",
            "minLength":1,
            "maxLength":1
        },
        "rejectLimit":{
            "description":"The operation will error out after specified number of rows are rejected.\n",
            "type":"integer",
            "format":"int32",
            "maximum":1000
        },
        "areRemoveQuotes":{
            "description":"Removes any quotes that are around any field in the source file.\n",
            "type":"boolean",
            "default":true
        },
        "skipHeadersLimit":{
            "description":"Specifies how many rows should be skipped from the start of the file.\n",
            "type":"integer",
            "format":"int32",
            "maximum":10
        },
        "timestampFormat":{
            "description":"Specifies the timestamp format in the source file.\nSee the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html\n",
            "example":"YYYY-MM-DD HH:MI:SS.FF\nYYYY-MM-DD HH:MI:SS.FF3\nMM/DD/YYYY HH:MI:SS.FF3\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "timestampLocalTimeZoneFormat":{
            "description":"Specifies the timestamp with local timezone format in the source file.\nSee the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html\n",
            "example":"DD Mon YYYY HH:MI:SS.FF TZR\nMM/DD/YYYY HH:MI:SS.FF TZR\nYYYY-MM-DD HH:MI:SS+/-TZR\nYYYY-MM-DD HH:MI:SS.FF3\nDD.MM.YYYY HH:MI:SS TZR\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "timestampTimeZoneFormat":{
            "description":"Specifies the timestamp with timezone format in the source file.\nSee the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html\n",
            "example":"DD Mon YYYY HH:MI:SS.FF TZR\nMM/DD/YYYY HH:MI:SS.FF TZR\nYYYY-MM-DD HH:MI:SS+/-TZR\nYYYY-MM-DD HH:MI:SS.FF3\nDD.MM.YYYY HH:MI:SS TZR\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "areTrimSpaces":{
            "description":"Specifies how the leading and trailing spaces of the fields are trimmed.\n",
            "type":"string",
            "enum":[
                "RTRIM",
                "LTRIM",
                "NOTRIM",
                "LRTRIM",
                "LDRTRIM"
            ],
            "default":"LDRTRIM"
        },
        "areTruncateColumn":{
            "description":"If the data in the file is too long for a field, then this option will truncate\nthe value of the field rather than reject the row.\n",
            "type":"boolean",
            "default":true
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Retrieves data of the given object for preview

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.

Root Schema : RowCollection

Type: object

Rows of Object Select preview, first row is column names

Show Source

items: array items

Maximum Number of Items: 10

Collection of rows which together form an object preview.

{
    "type":"object",
    "description":"Rows of Object Select preview, first row is column names",
    "example":"{\"items\": [[\"col1Name\", \"col2Name\"], [\"col1Row1Value\", \"col2Row1Value\"], [\"col1Row2Value\", \"col2Row2Value\"], [\"col1Row3Value\", \"col2Row3Value\"]]}",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Collection of rows which together form an object preview.",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "maxItems":10
        }
    }
}

Example:

{"items": [["col1Name", "col2Name"], ["col1Row1Value", "col2Row1Value"], ["col1Row2Value", "col2Row2Value"], ["col1Row3Value", "col2Row3Value"]]}

Nested Schema : items

Type: array

Maximum Number of Items: 10

Collection of rows which together form an object preview.

Show Source

Array of: array items

{
    "description":"Collection of rows which together form an object preview.",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "maxItems":10
}

Nested Schema : items

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Root Schema : DefaultError

Type: object

Error Information.

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

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

Minimum Length: 1

Maximum Length: 1024

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}