機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. サイト

サイト・リソースの問合せ構文の取得

get

/sites/management/api/v1/sites/search-form

SEARCH FORM

サイト・インスタンス検索の問合せ構文の詳細を取得します。search-formリソースを使用すると、Siteインスタンスの検索時にサポートされる問合せ構文を検索できます。 レスポンスは、プロパティ単位でサポートされる演算子を示します。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - Search Form Details

検索フォームのレスポンスの例。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/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"
      }
    },
    "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"
      }
  ]
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

400Bad Request - Deleted Filter Required

コンポーネント、テーマ、サイト、テンプレートなどのリソースのリストを作成する際、ごみ箱内にあるリソース、またはごみ箱にないリソースを一覧表示できます。ごみ箱内にあるリソースおよびごみ箱内にないリソースは一覧表示できません。 このエラーは、includeDeletedとq問合せパラメータの組合せが、ごみ箱内にあるリソースをリストしようとしており、ごみ箱内にありません。

エラー・コード

OCE-DOCS-001007

解決 - ごみ箱内のリソースのリスト

includeDeleted=trueとdeleted eq "true"の両方を指定して、ごみ箱にリソースをリストします。

解決 - ごみ箱にないリソースのリスト表示

includeDeleted=trueを指定しないか、フィルタでdeleted eq "true"式を使用して、ごみ箱にないリソースをリストします。

レスポンス本文の例
{
  "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"
}

リリース19.4.3での導入。

リクエスト

問合せパラメータ

  • レスポンスに含めないフィールド名のカンマ区切り文字列。

  • レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

  • レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。

  • レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

    次のリンクは、このリソースにより提供されます:

    リンク関係説明
    parent親リソースが読取り可能な場所を示します。 このリンクはupリンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
    selfリソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
    canonicalリクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
    searchリソースを検索できる場所を示します。 リソースからの検索に使用され、リソースを検索できるロケーションを示します。
    describedByリソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。
トップに戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

OK
ヘッダー
本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ: links
型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示
ネストされたスキーマ: members
型: object

「サイト」問合せの問合せ構文。

ソースを表示
ネストされたスキーマ : ownedBy.name
型: object

「サイト」問合せの問合せ構文。

ソースを表示
ネストされたスキーマ : ownedBy.user名前
型: object

「サイト」問合せの問合せ構文。

ソースを表示
ネストされたスキーマ : runtimeStatus
型: object

「サイト」問合せの問合せ構文。

ソースを表示
ネストされたスキーマ : 構文
型: object

「サイト」問合せの問合せ構文。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
ネストされたスキーマ : operators
型: array

サポートされている問合せ演算子のリスト。

ソースを表示
ネストされたスキーマ : operators
型: array

サポートされている問合せ演算子のリスト。

ソースを表示
ネストされたスキーマ : operators
型: array

サポートされている問合せ演算子のリスト。

ソースを表示
ネストされたスキーマ : operators
型: array

サポートされている問合せ演算子のリスト。

ソースを表示
ネストされたスキーマ : logicalOperators
型: object

サポートされている論理演算子。

ソースを表示
ネストされたスキーマ : operators
型: object

サポートされている演算子。

ソースを表示
ネストされたスキーマ : termDeliminator
型: array

アイテムの区切りに使用できる文字列。

ソースを表示
ネストされたスキーマ : and
型: object

論理積および.

ソースを表示
ネストされたスキーマ : not
型: object

論理名ではありません。

ソースを表示
ネストしたスキーマ : または
型: object

Logical or.

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストしたスキーマ : co
型: object

Contains.

ソースを表示
ネストしたスキーマ : eq
型: object

等しい

ソースを表示
ネストしたスキーマ : 新規
型: object

次で終わる

ソースを表示
ネストしたスキーマ : ge
型: object

次以上。

ソースを表示
ネストしたスキーマ : gt
型: object

より大きい

ソースを表示
ネストしたスキーマ : le
型: object

以下

ソースを表示
ネストしたスキーマ : lt
型: object

より小さい

ソースを表示
ネストしたスキーマ : ne
型: object

等しくない

ソースを表示
ネストしたスキーマ : pr
型: object

あり

ソースを表示
ネストしたスキーマ : sw
型: object

次で始まる

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
ネストされたスキーマ : code
型: array

演算子を表すためにこのカスタム問合せ形式で使用される文字列。

ソースを表示
ネストされたスキーマ : types
型: array

この演算子に適用可能なプロパティのタイプ。

ソースを表示
レスポンスの例(検索フォームの詳細)
{
    "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レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : DeletedRequiredExceptionDetail
リリース19.4.3での導入。
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

レスポンスの例(削除フィルタが必要)
{
    "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"
}

401レスポンス

未認可

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る