Jump to

• Request
• Response

Bulk queries.

post

/custom-actions/bulkQueries/<resourceName>

Request

Query Parameters

• useSavedQueryAsSubQuery: boolean
  Indicates whether to use a saved query as a subquery. Accepts true or false. This parameter will not work if the saved query contains an ORDER BY clause.

Header Parameters

• Prefer Transient Header: string
  A header parameter that allows you to execute queries. Set the request header "Prefer" to "transient" to explicitly declare that the query should be executed.

Supported Media Types

• application/vnd.oracle.resource+json;type=query-def

Request Body - application/vnd.oracle.resource+json;type=query-def ()

Root Schema : schema

Type: object

Show Source

• q(required): q

{
    "properties":{
        "q":{
            "$ref":"#/components/schemas/q"
        }
    },
    "required":[
        "q"
    ]
}

Nested Schema : q

Type: object

Show Source

• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.

{
    "properties":{
        "q":{
            "description":"Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default response.

Body ()

Root Schema : bulkQueryResponse

Type: object

Show Source

• pkCount: string
  Number of primary keys.
• pks: array pks
  List of primary keys.

{
    "properties":{
        "pkCount":{
            "type":"string",
            "description":"Number of primary keys."
        },
        "pks":{
            "type":"array",
            "description":"List of primary keys.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : pks

Type: array

List of primary keys.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of primary keys.",
    "items":{
        "type":"string"
    }
}

Back to Top