リクエスト・リソースの問合せ構文の取得
/sites/management/api/v1/requests/search-form
リクエスト・インスタンス検索の問合せ構文の詳細を取得します。search-form
リソースを使用すると、Request
インスタンスの検索時にサポートされる問合せ構文を検索できます。 レスポンスは、プロパティ単位でサポートされる演算子を示します。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK - Search Form Details
検索フォームのレスポンスの例。
リクエスト
GET https://api.example.com/sites/management/api/v1/requests/search-form
レスポンス本文
{ "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@3d1bbd92 (documentation: null) (name: ne, literal: ne)": { "code": [ "oracle.blend.blend.impl.FilterOperatorImpl@3d1bbd92 (documentation: null) (name: ne, literal: ne)" ], "types": [ "string" ], "description": "Not 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" }, "oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)": { "code": [ "oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)" ], "types": [ "object", "string" ], "description": "Contains" } }, "logicalOperators": { "and": { "code": [ "and" ], "description": "Logical And" }, "or": { "code": [ "or" ], "description": "Logical Or" }, "not": { "code": [ "not" ], "description": "Logical Not" } }, "termDeliminator": [ " " ], "precedenceGrouping": "()" }, "requestType": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "status": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)", "oracle.blend.blend.impl.FilterOperatorImpl@3d1bbd92 (documentation: null) (name: ne, literal: ne)" ] }, "createdBy.id": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "createdBy.userName": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "createdBy.name": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "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)" ] }, "lastModifiedAt": { "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)" ] }, "policy.approvalType": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "template.id": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "ownedBy.id": { "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)" ] }, "original.id": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "source.id": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)" ] }, "approvers": { "operators": [ "oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)" ] }, "links": [ { "rel": "parent", "href": "https://cloud.example.com/sites/management/api/v1/requests", "mediaType": "application/json", "method": "GET" }, { "rel": "self", "href": "https://cloud.example.com/sites/management/api/v1/requests/search-form", "mediaType": "application/json", "method": "GET" }, { "rel": "canonical", "href": "https://cloud.example.com/sites/management/api/v1/requests/search-form", "mediaType": "application/json", "method": "GET" }, { "rel": "search", "href": "https://cloud.example.com/sites/management/api/v1/requests", "mediaType": "application/json", "method": "GET" }, { "rel": "describedBy", "href": "https://cloud.example.com/sites/management/api/v1/metadata-catalog", "mediaType": "application/json", "method": "GET" } ] }
リクエスト
- excludeFields(optional): string
レスポンスに含めないフィールド名のカンマ区切り文字列。
- excludeLinks(optional): string
レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
- fields(optional): string
レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。
- links(optional): string
レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。
次のリンクは、このリソースにより提供されます:
リンク関係 説明 parent
親リソースが読取り可能な場所を示します。 このリンクは up
リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。self
リソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。 canonical
リクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。 search
リソースを検索できる場所を示します。 リソースからの検索に使用され、リソースを検索できるロケーションを示します。 describedBy
リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。
レスポンス
- application/json
- application/vnd.oracle.resource+json;type=search-form
200レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
object
- approvers: object approvers
「リクエスト」問合せの問合せ構文。
- createdAt: object createdAt
「リクエスト」問合せの問合せ構文。
- createdBy.id: object createdBy.id
「リクエスト」問合せの問合せ構文。
- createdBy.name: object createdBy.name
「リクエスト」問合せの問合せ構文。
- createdBy.userName: object createdBy.userName
「リクエスト」問合せの問合せ構文。
- lastModifiedAt: object lastModifiedAt
「リクエスト」問合せの問合せ構文。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- original.id: object original.id
「リクエスト」問合せの問合せ構文。
- ownedBy.id: object ownedBy.id
「リクエスト」問合せの問合せ構文。
- ownedBy.name: object ownedBy.name
「リクエスト」問合せの問合せ構文。
- ownedBy.userName: object ownedBy.userName
「リクエスト」問合せの問合せ構文。
- policy.approvalType: object policy.approvalType
「リクエスト」問合せの問合せ構文。
- requestType: object requestType
「リクエスト」問合せの問合せ構文。
- source.id: object source.id
「リクエスト」問合せの問合せ構文。
- status: object status
「リクエスト」問合せの問合せ構文。
- syntax: object syntax
「リクエスト」問合せの問合せ構文。
- template.id: object template.id
「リクエスト」問合せの問合せ構文。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
「リクエスト」問合せの問合せ構文。
- logicalOperators(optional): object logicalOperators
サポートされている論理演算子。
- operators(optional): object operators
サポートされている演算子。
- precedenceGrouping(optional): string
グループ用語に使用できる文字列。
- termDeliminator(optional): array termDeliminator
アイテムの区切りに使用できる文字列。
object
「リクエスト」問合せの問合せ構文。
- operators(optional): array operators
サポートされている問合せ演算子のリスト。
object
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのself
リンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
- href(optional): string
ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。 値がURIテンプレートに設定されている場合、
templated
プロパティをtrue
に設定する必要があります。 - mediaType(optional): string
メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
- method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
-
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)
ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
- rel(optional): string
リンクの詳細を取得するために使用できるリンク・リレーションの名前。
- templated(optional): boolean
href
プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、false
とみなすことができます。
object
サポートされている論理演算子。
- and(optional): object and
論理積および.
- not(optional): object not
論理名ではありません。
- or(optional): object or
Logical or.
object
サポートされている演算子。
- co(optional): object co
Contains.
- eq(optional): object eq
等しい
- ew(optional): object ew
次で終わる
- ge(optional): object ge
次以上。
- gt(optional): object gt
より大きい
- le(optional): object le
以下
- lt(optional): object lt
より小さい
- ne(optional): object ne
等しくない
- pr(optional): object pr
あり
- sw(optional): object sw
次で始まる
object
論理積および.
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
論理名ではありません。
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
Logical or.
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
Contains.
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
等しい
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
次で終わる
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
次以上。
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
より大きい
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
以下
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
より小さい
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
等しくない
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
あり
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
object
次で始まる
- code(optional): array code
演算子を表すためにこのカスタム問合せ形式で使用される文字列。
- description(optional): string
演算子の関数の解読可能な説明。
- example(optional): string
演算子の使用例。
- types(optional): array types
この演算子に適用可能なプロパティのタイプ。
{
"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@3d1bbd92 (documentation: null) (name: ne, literal: ne)":{
"code":[
"oracle.blend.blend.impl.FilterOperatorImpl@3d1bbd92 (documentation: null) (name: ne, literal: ne)"
],
"types":[
"string"
],
"description":"Not 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"
},
"oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)":{
"code":[
"oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)"
],
"types":[
"object",
"string"
],
"description":"Contains"
}
},
"logicalOperators":{
"and":{
"code":[
"and"
],
"description":"Logical And"
},
"or":{
"code":[
"or"
],
"description":"Logical Or"
},
"not":{
"code":[
"not"
],
"description":"Logical Not"
}
},
"termDeliminator":[
" "
],
"precedenceGrouping":"()"
},
"requestType":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"status":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)",
"oracle.blend.blend.impl.FilterOperatorImpl@3d1bbd92 (documentation: null) (name: ne, literal: ne)"
]
},
"createdBy.id":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"createdBy.userName":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"createdBy.name":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"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)"
]
},
"lastModifiedAt":{
"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)"
]
},
"policy.approvalType":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"template.id":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"ownedBy.id":{
"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)"
]
},
"original.id":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"source.id":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@22379eec (documentation: null) (name: eq, literal: eq)"
]
},
"approvers":{
"operators":[
"oracle.blend.blend.impl.FilterOperatorImpl@191a9ec8 (documentation: null) (name: co, literal: co)"
]
},
"links":[
{
"rel":"parent",
"href":"https://cloud.example.com/sites/management/api/v1/requests",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"self",
"href":"https://cloud.example.com/sites/management/api/v1/requests/search-form",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"canonical",
"href":"https://cloud.example.com/sites/management/api/v1/requests/search-form",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"search",
"href":"https://cloud.example.com/sites/management/api/v1/requests",
"mediaType":"application/json",
"method":"GET"
},
{
"rel":"describedBy",
"href":"https://cloud.example.com/sites/management/api/v1/metadata-catalog",
"mediaType":"application/json",
"method":"GET"
}
]
}