1. REST API for Sites Management
  2. Tasks
  3. Requests
  4. Reviews

Get the Query Syntax for Review Resources

get

/sites/management/api/v1/requests/{id}/reviews/search-form

SEARCH FORM

Get the query syntax details for searching review instances.The search-form resource can be used to find out, at runtime, what query syntax is supported when searching Review instances. The response describes which operators are supported on a per property basis.

Authorization

To access this search-form resource requires read access to the parent resource.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK - Search Form Details

Example search form response.

Request

GET https://api.example.com/sites/management/api/v1/requests/{id}/reviews/search-form

Response Body

{
  "syntax": {
    "operators": {
      "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)": {
        "code": [
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
        ],
        "types": [
            "string"
        ],
        "description": "Equals"
      },
      "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)": {
        "code": [
            "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)"
        ],
        "types": [
            "string"
        ],
        "description": "Greater Than"
      },
      "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)": {
        "code": [
            "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)"
        ],
        "types": [
            "string"
        ],
        "description": "Less Than"
      }
    },
    "logicalOperators": {
      "and": {
        "code": [
            "and"
        ],
        "description": "Logical And"
      },
      "or": {
        "code": [
            "or"
        ],
        "description": "Logical Or"
      },
      "not": {
        "code": [
            "not"
        ],
        "description": "Logical Not"
      }
    },
    "termDeliminator": [
        " "
    ],
    "precedenceGrouping": "()"
  },
  "createdAt": {
    "operators": [
        "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)",
        "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)",
        "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)"
    ]
  },
  "decision": {
    "operators": [
        "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
    ]
  },
  "reviewedBy.id": {
    "operators": [
        "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
    ]
  },
  "reviewedBy.userName": {
    "operators": [
        "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
    ]
  },
  "reviewedBy.name": {
    "operators": [
        "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
    ]
  },
  "links": [
      {
        "rel": "parent",
        "href": "https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "rel": "self",
        "href": "https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews/search-form",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "rel": "canonical",
        "href": "https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews/search-form",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "rel": "search",
        "href": "https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "rel": "describedBy",
        "href": "https://cloud.example.com/sites/management/api/v1/metadata-catalog",
        "mediaType": "application/json",
        "method": "GET"
      }
  ]
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Request Not Found

The request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.

Error Code

OCE-SITEMGMT-009001

Resolution - Check Identifier

Check that the request identifier is valid.

Resolution - Check Authorization

Check that the authenticated user can review the request or that the authenticated user is the user that created the request.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
requestRequest that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the RequestNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Request Not Found",
  "status": "404",
  "detail": "Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
  "o:errorCode": "OCE-SITEMGMT-009001",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

Request

Path Parameters

  • Globally unique immutable identifier for a request.

Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to true. When the includeDeleted query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    searchDescribes where the resource can be searched. Used on search from resources to indicate the location where the resource can be searched.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : createdAt
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : decision
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : links
Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source
Nested Schema : reviewedBy.id
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : reviewedBy.name
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : reviewedBy.userName
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : syntax
Type: object

Query syntax for Review queries.

Show Source
Nested Schema : operators
Type: array

List of supported query operators.

Show Source
Nested Schema : operators
Type: array

List of supported query operators.

Show Source
Nested Schema : items
Match All
Show Source
  • Link
Nested Schema : operators
Type: array

List of supported query operators.

Show Source
Nested Schema : operators
Type: array

List of supported query operators.

Show Source
Nested Schema : operators
Type: array

List of supported query operators.

Show Source
Nested Schema : logicalOperators
Type: object

Supported logical operators.

Show Source
Nested Schema : operators
Type: object

Supported operators.

Show Source
Nested Schema : termDeliminator
Type: array

Strings that can be used to delimit items.

Show Source
Nested Schema : and
Type: object

Logical and.

Show Source
Nested Schema : not
Type: object

Logical not.

Show Source
Nested Schema : or
Type: object

Logical or.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : co
Type: object

Contains.

Show Source
Nested Schema : eq
Type: object

Equals.

Show Source
Nested Schema : ew
Type: object

Ends with.

Show Source
Nested Schema : ge
Type: object

Greater or equals.

Show Source
Nested Schema : gt
Type: object

Greater than.

Show Source
Nested Schema : le
Type: object

Less than or equals.

Show Source
Nested Schema : lt
Type: object

Less than.

Show Source
Nested Schema : ne
Type: object

Not equals.

Show Source
Nested Schema : pr
Type: object

Present.

Show Source
Nested Schema : sw
Type: object

Starts with.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Nested Schema : code
Type: array

Strings used in this custom query format to represent the operator.

Show Source
Nested Schema : types
Type: array

Types of properties that are applicable for this operator.

Show Source
Example Response (Search Form Details)
{
    "syntax":{
        "operators":{
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)":{
                "code":[
                    "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
                ],
                "types":[
                    "string"
                ],
                "description":"Equals"
            },
            "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)":{
                "code":[
                    "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)"
                ],
                "types":[
                    "string"
                ],
                "description":"Greater Than"
            },
            "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)":{
                "code":[
                    "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)"
                ],
                "types":[
                    "string"
                ],
                "description":"Less Than"
            }
        },
        "logicalOperators":{
            "and":{
                "code":[
                    "and"
                ],
                "description":"Logical And"
            },
            "or":{
                "code":[
                    "or"
                ],
                "description":"Logical Or"
            },
            "not":{
                "code":[
                    "not"
                ],
                "description":"Logical Not"
            }
        },
        "termDeliminator":[
            " "
        ],
        "precedenceGrouping":"()"
    },
    "createdAt":{
        "operators":[
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)",
            "oracle.blend.blend.impl.FilterOperatorImpl@6cd327ef (documentation: null) (name: gt, literal: gt)",
            "oracle.blend.blend.impl.FilterOperatorImpl@46dd6619 (documentation: null) (name: lt, literal: lt)"
        ]
    },
    "decision":{
        "operators":[
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
        ]
    },
    "reviewedBy.id":{
        "operators":[
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
        ]
    },
    "reviewedBy.userName":{
        "operators":[
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
        ]
    },
    "reviewedBy.name":{
        "operators":[
            "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
        ]
    },
    "links":[
        {
            "rel":"parent",
            "href":"https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews",
            "mediaType":"application/json",
            "method":"GET"
        },
        {
            "rel":"self",
            "href":"https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews/search-form",
            "mediaType":"application/json",
            "method":"GET"
        },
        {
            "rel":"canonical",
            "href":"https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews/search-form",
            "mediaType":"application/json",
            "method":"GET"
        },
        {
            "rel":"search",
            "href":"https://cloud.example.com/sites/management/api/v1/requests/{id}/reviews",
            "mediaType":"application/json",
            "method":"GET"
        },
        {
            "rel":"describedBy",
            "href":"https://cloud.example.com/sites/management/api/v1/metadata-catalog",
            "mediaType":"application/json",
            "method":"GET"
        }
    ]
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : RequestNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : RequestNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Request Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Request Not Found",
    "status":"404",
    "detail":"Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
    "o:errorCode":"OCE-SITEMGMT-009001",
    "request":{
        "id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
    }
}

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top