Get the Query Syntax for Site Resources
/sites/management/api/v1/sites/search-form
Get the query syntax details for searching site instances.The search-form resource can be used to find out, at runtime, what query syntax is supported when searching Site instances. The response describes which operators are supported on a per property basis.
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/sites/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" } }, "logicalOperators": { "and": { "code": [ "and" ], "description": "Logical And" }, "or": { "code": [ "or" ], "description": "Logical Or" }, "not": { "code": [ "not" ], "description": "Logical Not" } }, "termDeliminator": [ " " ], "precedenceGrouping": "()" }, "runtimeStatus": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "ownedBy.userName": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "ownedBy.name": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "members": { "operators": [ ] }, "links": [ { "rel": "parent", "href": "https://cloud.example.com/sites/management/api/v1/sites", "mediaType": "application/json", "method": "GET" }, { "rel": "self", "href": "https://cloud.example.com/sites/management/api/v1/sites/search-form", "mediaType": "application/json", "method": "GET" }, { "rel": "canonical", "href": "https://cloud.example.com/sites/management/api/v1/sites/search-form", "mediaType": "application/json", "method": "GET" }, { "rel": "search", "href": "https://cloud.example.com/sites/management/api/v1/sites", "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.
400Bad Request - Deleted Filter Required
When listing resources such as components, themes, sites and templates you can either list resources in the trash or not in the trash; you cannot list resources that are both in and not in the trash. This error indicates that the combination of includeDeleted and the q query parameter are trying to list resources in the trash and not in the trash.
Error Code
OCE-DOCS-001007
Resolution - Listing Resources in Trash
Specify both includeDeleted=true and deleted eq "true" to list resources in the trash.
Resolution - Listing Resources Not in Trash
Do not specify includeDeleted=true or use the expression deleted eq "true" in the filter to
list resources not in the trash.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Deleted Filter Required", "status": "400", "detail": "You cannot list resources in the trash and not in the trash at the same time.", "o:errorCode": "OCE-DOCS-001007" }
Introduced in release 19.4.3.
Request
-
excludeFields(optional): string
Comma-delimited string of field names that should not be included in the response.
-
excludeLinks(optional): string
Comma-separated list of link relation names to exclude from the response.
-
fields(optional): string
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.
-
links(optional): string
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 Relationship Description parentDescribes where the parent resource can be read. Equivalent to an uplink, 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.
Response
- application/json
- application/vnd.oracle.resource+json;type=search-form
200 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
object-
links(optional):
array links
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.
-
members:
object members
Query syntax for Site queries.
-
ownedBy.name:
object ownedBy.name
Query syntax for Site queries.
-
ownedBy.userName:
object ownedBy.userName
Query syntax for Site queries.
-
runtimeStatus:
object runtimeStatus
Query syntax for Site queries.
-
syntax:
object syntax
Query syntax for Site queries.
arrayHATEOS 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.
objectQuery syntax for Site queries.
-
operators(optional):
array operators
List of supported query operators.
objectQuery syntax for Site queries.
-
operators(optional):
array operators
List of supported query operators.
objectQuery syntax for Site queries.
-
operators(optional):
array operators
List of supported query operators.
objectQuery syntax for Site queries.
-
operators(optional):
array operators
List of supported query operators.
objectQuery syntax for Site queries.
-
logicalOperators(optional):
object logicalOperators
Supported logical operators.
-
operators(optional):
object operators
Supported operators.
-
precedenceGrouping(optional):
string
Strings that can be used to group terms.
-
termDeliminator(optional):
array termDeliminator
Strings that can be used to delimit items.
objectREST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templatedproperty must be set totrue. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS- HTTP OPTIONS -
HEAD- HTTP HEAD -
GET- HTTP GET -
POST- HTTP POST -
PUT- HTTP PUT -
PATCH- HTTP PATCH -
DELETE- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
hrefproperty is a URI or URI Template. The property can be assumed to befalseif the property is not present.
objectSupported logical operators.
-
and(optional):
object and
Logical and.
-
not(optional):
object not
Logical not.
-
or(optional):
object or
Logical or.
objectSupported operators.
-
co(optional):
object co
Contains.
-
eq(optional):
object eq
Equals.
-
ew(optional):
object ew
Ends with.
-
ge(optional):
object ge
Greater or equals.
-
gt(optional):
object gt
Greater than.
-
le(optional):
object le
Less than or equals.
-
lt(optional):
object lt
Less than.
-
ne(optional):
object ne
Not equals.
-
pr(optional):
object pr
Present.
-
sw(optional):
object sw
Starts with.
objectLogical and.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectLogical not.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectLogical or.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
objectContains.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectEquals.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectEnds with.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectGreater or equals.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectGreater than.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectLess than or equals.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectLess than.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectNot equals.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectPresent.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
objectStarts with.
-
code(optional):
array code
Strings used in this custom query format to represent the operator.
-
description(optional):
string
Human-readable description of the function of the operator.
-
example(optional):
string
Example of how to use the operator.
-
types(optional):
array types
Types of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
arrayStrings used in this custom query format to represent the operator.
arrayTypes of properties that are applicable for this operator.
{
"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"
}
},
"logicalOperators":{
"and":{
"code":[
"and"
],
"description":"Logical And"
},
"or":{
"code":[
"or"
],
"description":"Logical Or"
},
"not":{
"code":[
"not"
],
"description":"Logical Not"
}
},
"termDeliminator":[
" "
],
"precedenceGrouping":"()"
},
"runtimeStatus":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"ownedBy.userName":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"ownedBy.name":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"members":{
"operators":[
]
},
"links":[
{
"rel":"parent",
"href":"https://cloud.example.com/sites/management/api/v1/sites",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"self",
"href":"https://cloud.example.com/sites/management/api/v1/sites/search-form",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"canonical",
"href":"https://cloud.example.com/sites/management/api/v1/sites/search-form",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"search",
"href":"https://cloud.example.com/sites/management/api/v1/sites",
"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
-
allOf
DeletedRequiredExceptionDetail
Introduced in release 19.4.3.
-
object
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.
-
objectIn 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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
titleordetail. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCodefor this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
arrayMultiple errors can be organized in a hierarchical structure.
-
object
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.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Deleted Filter Required",
"status":"400",
"detail":"You cannot list resources in the trash and not in the trash at the same time.",
"o:errorCode":"OCE-DOCS-001007"
}