機械翻訳について

移動先

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

検索可能なメタデータ・フィールドの設定

post

/documents/api/1.2/metadata/searchFields

メタデータ・フィールドのリストの検索をオンにします。 同じグローバル・コレクションのメタデータ・フィールドのみを同じリクエストで処理できます。

現在、検索可能なメタデータ・フィールドの数は200に制限されており、それ以降、追加のフィールドは索引付けできません。 これらのメタデータ・フィールドおよびメタデータ・コレクションは、管理者がそれらを削除すると、検索索引から削除されます。 このアクションにより、インデックス付きメタデータ・フィールドの数が少なくなり、ユーザーは新しいフィールドにインデックスを作成できます。

管理者としてログインする必要があります。 検索可能なメタデータ・フィールドは、すべてのテナント・ユーザーが使用できます。

リクエスト

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

• application/json
• application/xml

本文 ()

リクエスト本文は、検索可能なメタデータ・フィールドの設定の詳細を定義します。

ルート・スキーマ : SetSearchableMetadataRequestBody

タイプ: object

検索可能なメタデータ・フィールドの設定に使用できるフィールドの説明。

ソースを表示

• collection: string
  Metadataコレクション名。
• fields: string
  検索可能として設定するメタデータ・フィールドのカンマ区切りリスト。

{
    "description":"Description of fields available to set searchable metadata fields.",
    "properties":{
        "collection":{
            "type":"string",
            "description":"Metadata collection name."
        },
        "fields":{
            "type":"string",
            "description":"Comma-separated list of metadata fields to be set as searchable."
        }
    },
    "required":[
        "collection",
        "fields"
    ]
}

リクエストの例(application/json)

{
    "collection":"SearchableCollection",
    "fields":"searchField1,searchField2,searchField3"
}

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ : SetSearchableMetadataResponse

タイプ: object

レスポンス本文は、リクエストが成功したかどうかを確認します。

ソースを表示

• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです

{
    "description":"The response body confirms if the request was successful.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

検索可能なメタデータ・フィールドの数を超えました。

404レスポンス

コレクションまたはフィールドが存在しません。

トップに戻る

例

次の例では、いくつかのメタデータ・フィールドを検索目的に使用できるようにします。

POST .../metadata/searchFields

リクエスト・ヘッダー

なし。

リクエスト本文

{
  "collection":"SearchableCollection",
  "fields":"searchField1,searchField2,searchField3"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

先頭に戻る