一般的なエラー
一般的なエラー
メタデータクエリAPIのエラーのほとんどは、他のAPIによって返されるエラーに似ています。ただし、現在、一部の正しくないクライアントリクエストでは、適切な400 Bad Request
エラーではなく、サーバー 側のエラーとともに、5XX
の範囲のHTTPステータスコードが返される場合があります。
これは既知の問題であり、近日中に解決される予定です。
テンプレートキーとスコープが正しくない
一般的なエラーとして、リクエストのfrom
値に誤った値が使用されると、HTTP 4XX
の範囲のさまざまなエラーが生じる可能性があります。
正しいfrom
値を使用しないと、APIは検索対象のテンプレートを認識できません。from
の値は、scope.templateKey
の形式にする必要があります。
この場合、scope
は会社のテンプレートのスコープで、enterprise_123456
のようになります。ここでの数値は会社のIDです。global
スコープや短縮形のenterprise
スコープなど、この形式に一致しないスコープではエラーが返されます。
templateKey
は、社内のメタデータテンプレートの一意のキーです。指定したキーを持つテンプレートが存在しない場合、またはキーが存在しないのにそのキーが誤った会社で使用されている場合は、このAPIによってエラーが返されます。
query_param
に値がない
一般的なエラーとして、query_params
オブジェクトにクエリ引数を含めるのを忘れると、unexpected_json_type
というコードとともにHTTP 400
エラーが返されます。
query_params
にすべての引数が存在しないと、APIはリクエストを完全なクエリにコンパイルできません。
たとえば、検索query
がamount >= :value AND status = :status
のようになっているとします。コロン:
で始まる引数はすべて、query_params
に存在する必要があります。この場合、クエリパラメータは次のようになります。これらの値のいずれかを忘れると、エラーが発生します。
"query_params": {
"value": 100,
"status": "active"
}
ancestor_folder_id
がない
一般的なエラーとして、リクエストにancestor_folder_id
を指定し忘れると、bad_request
というコードとともにHTTP 400
エラーが返されます。
ancestor_folder_id
値がないと、APIは、検索対象の結果が含まれているフォルダを認識できません。よくわからない場合は、値0
を使用すると、ユーザーのルートフォルダを指定できます。