機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

検索可能なメタデータ・フィールドの取得

get

/documents/api/1.2/metadata/searchFields

コンテンツの検索に現在使用可能なすべてのメタデータ・フィールドを取得します。 結果リストには、そのテナントに対応するグローバル・メタデータ・コレクションのプレフィクスが付いたすべてのメタデータ・フィールドが含まれます。

リクエスト

この操作のリクエスト・パラメータはありません。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ : GetSearchableMetadataResponse

タイプ: object

レスポンス本文には、検索目的で使用可能なすべてのメタデータ・フィールドに関する情報が含まれます。

ソースを表示

• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです
• fields(optional): string
  検索可能なメタデータ・フィールドのカンマ区切りリストで、プレフィクスとしてそれぞれのコレクション名が付けられます。
• number(optional): number
  検索可能なメタデータ・フィールドの数が取得されました。
• type(optional): string
  アイテム・タイプmetadata。

{
    "description":"The response body includes information about all metadata fields available for search purposes.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "number":{
            "type":"number",
            "description":"Number of searchable metadata fields retrieved."
        },
        "fields":{
            "type":"string",
            "description":"Comma-separated list of searchable metadata fields prefixed with their respective collection name."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>metadata</code>."
        }
    }
}

レスポンスの例(application/json)

{
    "type":"metadata",
    "errorCode":"0",
    "number":"3",
    "fields":"SearchableCollection.searchField1,SearchableCollection.searchField2,SearchableCollection.searchField3"
}

トップに戻る

例

次の例では、この特定のテナントで使用可能なすべての検索可能なメタデータ・フィールドを取得します。

GET .../metadata/searchFields

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "fields": "SearchableCollection.searchField1,SearchableCollection.searchField2,SearchableCollection.searchField3",
    "number": "3",
    "type": "metadata"
}

先頭に戻る