Jump to

• Request
• Response

Advanced Queries

post

/custom-actions/queries/<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

• copiedFrom: string
  GID of a previously created saved query.The requirements are that the saved query exists, is associated with the resource data and contains a SQL syntax query string. The SELECT statement in the saved query must only select the primary key columns for the corresponding resource.
• parameterValues: object parameterValues
  A property map where the key is the position or name of the bind parameter.
• q(required): q

{
    "properties":{
        "q":{
            "$ref":"#/components/schemas/q"
        },
        "copiedFrom":{
            "type":"string",
            "description":"GID of a previously created saved query.The requirements are that the saved query exists, is associated with the resource data and contains a SQL syntax query string. The SELECT statement in the saved query must only select the primary key columns for the corresponding resource."
        },
        "parameterValues":{
            "type":"object",
            "description":"A property map where the key is the position or name of the bind parameter.",
            "properties":{
                "parameterKey":{
                    "type":"string",
                    "description":"The key of the bind parameter (positional or named parameter)."
                },
                "parameterValue":{
                    "type":"string",
                    "description":"The value of the bind parameter."
                }
            }
        }
    },
    "required":[
        "q"
    ]
}

Nested Schema : parameterValues

Type: object

A property map where the key is the position or name of the bind parameter.

Show Source

• parameterKey: string
  The key of the bind parameter (positional or named parameter).
• parameterValue: string
  The value of the bind parameter.

{
    "type":"object",
    "description":"A property map where the key is the position or name of the bind parameter.",
    "properties":{
        "parameterKey":{
            "type":"string",
            "description":"The key of the bind parameter (positional or named parameter)."
        },
        "parameterValue":{
            "type":"string",
            "description":"The value of the bind parameter."
        }
    }
}

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

Type: object

Show Source

• items: array items
  List of objects which match the advanced query.

{
    "properties":{
        "items":{
            "type":"array",
            "description":"List of objects which match the advanced query.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

List of objects which match the advanced query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of objects which match the advanced query.",
    "items":{
        "type":"string"
    }
}

Back to Top