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.

Jump to

• Request
• Response

Get query execution result

get

/20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/result

Request

Supported Media Types

• application/json

Path Parameters

• projectId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of Query Service project
• queryExecutionId: string
  Minimum Length: 1

  Maximum Length: 255

  The ID of the asynchronous request.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 100
• page: string
  Minimum Length: 1

  The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.
• opc-retry-token(optional): string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• 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 : QueryExecutionResult

Type: object

asynchronous query execution result

Show Source

• fieldsCollection(optional): object FieldsCollection
  A list of fields that make up the schema.
• rows: array rows
  array of results

{
    "type":"object",
    "required":[
        "rows"
    ],
    "description":"asynchronous query execution result",
    "properties":{
        "fieldsCollection":{
            "$ref":"#/definitions/FieldsCollection"
        },
        "rows":{
            "type":"array",
            "description":"array of results",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : FieldsCollection

Type: object

A list of fields that make up the schema.

Show Source

• items: array items
  A list of fields that make up the schema.

{
    "type":"object",
    "description":"A list of fields that make up the schema.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A list of fields that make up the schema.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FieldSchema"
            }
        }
    }
}

Nested Schema : rows

Type: array

array of results

Show Source

• Array of: array items

{
    "type":"array",
    "description":"array of results",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : items

Type: array

A list of fields that make up the schema.

Show Source

• Array of: object FieldSchema
  A field schema decribes a particular field in the object schema. It contains at least a name and a data type, but potentially can be extended with some additional or more complex properties.

{
    "description":"A list of fields that make up the schema.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FieldSchema"
    }
}

Nested Schema : FieldSchema

Type: object

A field schema decribes a particular field in the object schema. It contains at least a name and a data type, but potentially can be extended with some additional or more complex properties.

Show Source

• additionalFlags(optional): object AdditionalFlags
  Additional flags which further clarifies the primary and logical types, or provide data type constraints.
• dataType: string
  Allowed Values: [ "BOOLEAN", "INT", "LONG", "FLOAT", "DOUBLE", "BYTES", "STRING", "ENUM", "ARRAY", "MAP", "FIXED" ]

  Data type of the field. Possible values include STRING, INTEGER, ...
• fieldName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of the field
• logicalType(optional): string
  Allowed Values: [ "DECIMAL", "UUID", "DATE", "TIME_MILLIS", "TIME_MICROS", "TIMESTAMP_MILLIS", "TIMESTAMP_MICROS", "LOCAL_TIMESTAMP_MILLIS", "LOCAL_TIMESTAMP_MICROS", "DURATION" ]

  Logical data type of the field which extends or clarifies the primary data type.
• oracleType(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Oracle DB data type of the field which extends or clarifies the primary data type.

{
    "type":"object",
    "description":"A field schema decribes a particular field in the object schema.\nIt contains at least a name and a data type, but potentially can be\nextended with some additional or more complex properties.\n",
    "required":[
        "fieldName",
        "dataType"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the field",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "dataType":{
            "description":"Data type of the field. Possible values include STRING, INTEGER, ...",
            "type":"string",
            "enum":[
                "BOOLEAN",
                "INT",
                "LONG",
                "FLOAT",
                "DOUBLE",
                "BYTES",
                "STRING",
                "ENUM",
                "ARRAY",
                "MAP",
                "FIXED"
            ]
        },
        "logicalType":{
            "description":"Logical data type of the field which extends or clarifies the primary data type.",
            "type":"string",
            "enum":[
                "DECIMAL",
                "UUID",
                "DATE",
                "TIME_MILLIS",
                "TIME_MICROS",
                "TIMESTAMP_MILLIS",
                "TIMESTAMP_MICROS",
                "LOCAL_TIMESTAMP_MILLIS",
                "LOCAL_TIMESTAMP_MICROS",
                "DURATION"
            ]
        },
        "oracleType":{
            "description":"Oracle DB data type of the field which extends or clarifies the primary data type.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-example":{
                "application-json":"{\n  \"oracleType\": \"VARCHAR2(4000 BYTE)\"\n}\n"
            }
        },
        "additionalFlags":{
            "$ref":"#/definitions/AdditionalFlags"
        }
    }
}

Nested Schema : AdditionalFlags

Type: object

Additional flags which further clarifies the primary and logical types, or provide data type constraints.

Show Source

• arrayType(optional): string
  A type of array values, can be used only with the array logical type.
• decimalPrecision(optional): integer(int32)
  An integer representing the (maximum) precision of decimals stored in this type, can be used only with the decimal logical type
• decimalScale(optional): integer(int32)
  An integer representing the scale, can be used only with the decimal logical type.
• defaultValue(optional): string
  Minimum Length: 1

  Maximum Length: 255

  A default value of the given type.
• enumConstants(optional): array enumConstants
  A list of string constants for a particular enum, can be used only with the enum logical type.
• fixedSize(optional): integer(int32)
  Length of the fixed-sized string, can be used only with the fixed logical type.
• isNullable(optional): boolean
  Default Value: true

  Marks a type as nullable. The default value is true and as such it's necessary explicitly state only if the type is not nullable.
• mapValueType(optional): string
  Allowed Values: [ "BOOLEAN", "INT", "LONG", "FLOAT", "DOUBLE", "BYTES", "STRING" ]

  A type of map values, can be used only with the map logical type.
• stringSize(optional): integer(int32)
  An integer representing the (maximum) size of string stored in this type, can be used only with the string data type

{
    "type":"object",
    "description":"Additional flags which further clarifies the primary and logical types,\nor provide data type constraints.\n",
    "properties":{
        "isNullable":{
            "description":"Marks a type as nullable. The default value is true and as such it's necessary explicitly state only if the type is not nullable.\n",
            "type":"boolean",
            "default":true
        },
        "defaultValue":{
            "description":"A default value of the given type.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "decimalScale":{
            "description":"An integer representing the scale, can be used only with the decimal logical type.",
            "type":"integer",
            "format":"int32"
        },
        "decimalPrecision":{
            "description":"An integer representing the (maximum) precision of decimals stored in this type,\ncan be used only with the decimal logical type\n",
            "type":"integer",
            "format":"int32"
        },
        "stringSize":{
            "description":"An integer representing the (maximum) size of string stored in this type,\ncan be used only with the string data type\n",
            "type":"integer",
            "format":"int32"
        },
        "enumConstants":{
            "description":"A list of string constants for a particular enum, can be used only with the enum logical type.\n",
            "type":"array",
            "items":{
                "type":"string"
            },
            "x-example":{
                "application-json":"{\n  \"enumConstants\": [\"GOLD\", \"SILVER\", \"IRON\"]\n}\n"
            }
        },
        "arrayType":{
            "description":"A type of array values, can be used only with the array logical type.\n",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/AdditionalFlags/mapValueType"
        },
        "mapValueType":{
            "description":"A type of map values, can be used only with the map logical type.\n",
            "type":"string",
            "enum":[
                "BOOLEAN",
                "INT",
                "LONG",
                "FLOAT",
                "DOUBLE",
                "BYTES",
                "STRING"
            ]
        },
        "fixedSize":{
            "description":"Length of the fixed-sized string, can be used only with the fixed logical type.\n",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : enumConstants

Type: array

A list of string constants for a particular enum, can be used only with the enum logical type.

Show Source

• Array of: string

{
    "description":"A list of string constants for a particular enum, can be used only with the enum logical type.\n",
    "type":"array",
    "items":{
        "type":"string"
    },
    "x-example":{
        "application-json":"{\n  \"enumConstants\": [\"GOLD\", \"SILVER\", \"IRON\"]\n}\n"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

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

Body ()

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.

Body ()

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.

Body ()

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
        }
    }
}

Back to Top