一般的なエラー

一般的なエラー

メタデータクエリAPIのエラーのほとんどは、他のAPIによって返されるエラーに似ています。ただし、現在、一部の正しくないクライアントリクエストでは、適切な400 Bad Requestエラーではなく、サーバー側のエラーとともに、5XXの範囲のHTTPステータスコードが返される場合があります。

これは既知の問題であり、近日中に解決される予定です。

テンプレートキーとスコープが正しくない

一般的なエラーとして、リクエストのfrom値に誤った値が使用されると、HTTP 4XXの範囲のさまざまなエラーが生じる可能性があります。

正しいfrom値を使用しないと、APIは検索対象のテンプレートを認識できません。fromの値は、scope.templateKeyの形式にする必要があります。

この場合、scopeは会社のテンプレートのスコープで、enterprise_123456のようになります。ここでの数値は会社のIDです。globalスコープや短縮形のenterpriseスコープなど、この形式に一致しないスコープではエラーが返されます。

templateKeyは、社内のメタデータテンプレートの一意のキーです。指定したキーを持つテンプレートが存在しない場合、またはキーが存在しないのにそのキーが誤った会社で使用されている場合は、このAPIによってエラーが返されます。

[GET /metadata_templates/enterpriseget-templates] APIを使用すると、scopetemplateKeyを含む、社内で使用できるすべての会社のリストを取得できます。

query_paramに値がない

一般的なエラーとして、query_paramsオブジェクトにクエリ引数を含めるのを忘れると、unexpected_json_typeというコードとともにHTTP 400エラーが返されます。

query_paramsにすべての引数が存在しないと、APIはリクエストを完全なクエリにコンパイルできません。

たとえば、検索queryamount >= :value AND status = :statusのようになっているとします。コロン:で始まる引数はすべて、query_paramsに存在する必要があります。この場合、クエリパラメータは次のようになります。これらの値のいずれかを忘れると、エラーが発生します。

"query_params": {
  "value": 100,
  "status": "active"
}

各引数の名前は開発者の好みに合わせて構成できるため、フィールドキーと一致させる必要はありません。必要なのは、先頭に:を付けることだけです。

検索インデックスがない

規模を考慮したことにより、メタデータテンプレートが10,000を超えるファイルまたはフォルダに適用されている場合、メタデータクエリによってHTTP 403エラーが返される可能性があります。検索インデックスを作成すると、特定の検索クエリでこのエラーを解決することができます。

メタデータインスタンスの数が10,000個を超えると、​use_index​パラメータに適切なインデックスが含まれていないメタデータクエリリクエストではエラーが発生します。このエラーは呼び出し元に対して、​use_index​パラメータの引数として適切なインデックスを指定するよう通知します。

インデックスの作成と使用の詳細を確認する

ancestor_folder_idがない

一般的なエラーとして、リクエストにancestor_folder_idを指定し忘れると、bad_requestというコードとともにHTTP 400エラーが返されます。

ancestor_folder_id値がないと、APIは、検索対象の結果が含まれているフォルダを認識できません。よくわからない場合は、値0を使用すると、ユーザーのルートフォルダを指定できます。