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

Success! A successful POST method returns a 200 status code.

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

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized, the request was not successful because it lacks valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top