本文へスキップ
Sursa Developers

エラーコード

エラーレスポンスはすべて同じ形式です。HTTPステータスとerror.codeで判断してください。error.messageは人が読むための英語のテキストで、変わることがあります。

エラーの形式

{
  "detail": "…",
  "error": {
    "code": "api.cursor_invalid",
    "message": "The cursor is malformed or was issued for different filters.",
    "details": {"parameter": "cursor"},
    "request_id": "01JB7Q2M4X9V3K8T5N6P0R1S2A",
    "doc_url": "https://developers.sursa.com/errors/api.cursor_invalid"
  }
}

error.codeはこのページのコードです。error.request_idはX-Request-Idヘッダーと一致します。error.doc_urlはこのページへのリンクです。

access_requests

analytics

announcements

answers

api

api_keys

api_logs

  • 404api_logs.not_foundリクエストがAPIログに見つからないか、14日より前のものです

auth

authz

billing

  • 402billing.seats_exceededサブスクリプションの{purchased}ライセンスがすべて使用されています(アクティブなユーザーと保留中の招待が{reserved}件)。さらに招待するには、「Billing」(料金と請求)ページでライセンスを追加してください。

cards

catalog

categories

collections

  • 403collections.admin_fieldsコレクションのアクセス設定、機密度、デフォルト値、検索の設定には、adminロールが必要です
  • 409collections.index_outdatedこのコレクションのインデックスは古くなっています。先にアップグレードしてください:upgrade_index: trueを指定したPATCH /v1/collections/{name}で、コレクションが再インデックスされます
  • 409collections.indexing_in_progressこのコレクションのドキュメントは現在インデックス作成中です。検索の設定は、インデックス作成が終わってから変更してください
  • 400collections.invalid_nameコレクションの名前が無効です:1〜64文字のラテン文字、数字、'_'、'-'
  • 403collections.no_accessコレクション'{name}'に対する'{action}'のアクセス権がありません
  • 403collections.no_write_accessコレクション'{name}'に対する書き込みアクセス権がありません
  • 404collections.not_foundコレクション'{name}'が見つかりません

comments

conversations

drafts

  • 409drafts.already_requestedこの下書きについては、すでに公開がリクエストされています。レビューを待つ間も編集を続けられます
  • 409drafts.card_deletedこの下書きのカードは削除されました
  • 409drafts.card_publishedこの下書きの作成後に、カードが公開または変更されました。公開されたバージョンから新しい下書きを作成してください
  • 422drafts.content_json_invalidcontent_jsonは、schemaVersion(文字列)とdoc(オブジェクト)を含む、最大500000バイトのオブジェクトにしてください
  • 409drafts.deleted_by_collaborator別の共同編集者がこの下書きを削除しました。編集を続けるには、新しい下書きを作成してください
  • 409drafts.existsこのカードの下書きはすでにあります
  • 422drafts.invalid_scopescopeはmine、all、orphanedのいずれかにしてください
  • 403drafts.not_collaboratorこの下書きを変更できるのは、共同編集者または管理者だけです
  • 404drafts.not_found下書きが見つかりません
  • 409drafts.not_requestedこの下書きの公開はリクエストされていません
  • 403drafts.publish_forbiddenこのコレクションに公開する権限がありません
  • 422drafts.scheduled_past予約日は未来の日付にしてください
  • 422drafts.title_requiredタイトルは必須です

events

  • 404events.not_foundイベントが見つからないか、30日より前のものです

files

  • 410files.expiredファイルの有効期限が切れています
  • 422files.infectedファイル{filename}はウイルススキャンによって拒否されました:{signature}
  • 422files.invalid_expiry_filterexpiryはactive、expiring、expiredのいずれかにしてください
  • 422files.invalid_kind_filterkindはpdf、xlsx、csv、docx、mdのいずれかにしてください
  • 422files.invalid_origin_filteroriginはanswer、card、insights、listのいずれかにしてください
  • 409files.no_expiryこのファイルは有効期限なしで保持されています
  • 404files.not_foundファイルが見つかりません
  • 409files.not_regenerable{reason}
  • 422files.preview_failedこのファイルをプレビューできません:{reason}
  • 404files.regeneration_requiredこのファイルはメインアドレスで作成されたもので、API専用アドレスでは返されない詳細を含んでいます。POST /v1/files/{file_id}/regenerateで再生成するか、メインアドレスでダウンロードしてください
  • 409files.removedこのファイルは有効期限の後にすでに削除されました。代わりに再作成してください
  • 503files.scan_unavailableウイルススキャンを利用できません。しばらくしてから再試行してください
  • 413files.too_largeファイル{filename}は、アップロードの上限{limit}を超えています
  • 415files.type_mismatchファイル{filename}がその種類と一致しません:拡張子{extension}、申告された種類{declared}、内容{detected}

finance

folders

  • 400folders.appearance_invalidcolorはblue、violet、emerald、amber、orange、rose、cyan、slateのいずれか、iconはカテゴリのキーまたはlockにしてください
  • 400folders.card_collection_mismatchカードとフォルダーが異なるコレクションに属しています
  • 409folders.cycleフォルダーを、そのフォルダー自身またはそのサブフォルダーに移動することはできません
  • 409folders.depth_exceeded移動後のフォルダーの階層が上限の3を超えます
  • 404folders.not_foundフォルダーが見つかりません
  • 400folders.parent_mismatch親フォルダーが別のコレクションに属しています
  • 400folders.sibling_not_foundprev_sibling_idは'first'、'last'、または移動先の親にある同じ階層のフォルダーのIDにしてください
  • 400folders.title_invalidフォルダーのタイトルは1〜200文字にしてください

insights

internal

jobs

  • 409jobs.already_processingジョブはすでに処理中のため、キューから削除できません
  • 409jobs.cancel_failedジョブをキューから削除できませんでした
  • 410jobs.cancel_unsupportedこのジョブは、キャンセルがサポートされる前にキューに入りました。完了するまでお待ちください
  • 422jobs.invalid_filter{reason}
  • 404jobs.not_foundジョブが見つかりません
  • 409jobs.not_queuedキューから削除できるのは、キューにあるジョブだけです(このジョブの状態は{status})

limits

  • 402limits.cards組織は、カードの上限{limit}件{plan}に達しました。不要なカードを削除するか、システム管理者に上限の引き上げを依頼してください。
  • 429limits.concurrent_answers組織ではすでに{used}件の回答が処理中です(上限{limit}件)。数秒後にもう一度お試しください
  • 429limits.questions組織は、24時間あたりの質問の上限{limit}件{plan}を使い切りました。質問は約{wait}後に再び利用できるようになります。さらに必要な場合は、システム管理者に上限の引き上げを依頼してください。
  • 402limits.sources組織は、ソースの上限{limit}件{plan}に達しました。不要なソースを削除するか、システム管理者に上限の引き上げを依頼してください。
  • 402limits.sources_instant即時更新は組織のプラン{plan}に含まれていません。ソースはスケジュールどおりに更新されます。
  • 402limits.storageストレージが不足しています:組織は{limit}GB{plan}のうち{used}GBを使用しており、このファイルにはさらに{amount}が必要です。不要なカードやファイルを削除するか、システム管理者に上限の引き上げを依頼してください。
  • 402limits.users組織は、ユーザーの上限{limit}人{plan}に達しました(アクティブなユーザーと保留中の招待を含む)。不要なアカウントを無効にするか招待を取り消すか、システム管理者に上限の引き上げを依頼してください。

notifications

oauth

  • 403oauth.operation_not_allowedこの操作はOAuthアプリのトークンでは利用できません
  • 401oauth.token_expiredアクセストークンの有効期限が切れています。リフレッシュトークンで新しいトークンを取得してください

oauth_apps

oauth_authorizations

org

  • 403org.deletedこの組織は削除されています
  • 404org.not_found組織が見つかりません
  • 403org.suspendedこの組織は停止されています:サインインはできませんが、データは保持されています。管理者に問い合わせてください

profiles

quality

query

questions

sources

tasks

uploads

users

users_import

validation

verification

view_as

  • 403view_as.admin_key_requiredX-View-Asには、adminロールのAPIキーが必要です
  • 400view_as.invalid_headerX-View-Asは、存在するプロファイルを指定した<profile>[:viewer|verifier|editor]の形式でなければなりません
  • 403view_as.read_only表示モード:別のプロファイルとして表示している間は、変更できません

webhooks

  • 400webhooks.access_invalidWebhookのロール、ペイロードモード、データプロファイル、コレクション、またはタグが無効です
  • 400webhooks.auth_invalid送信時の認可は、トークン付きのbearer、またはユーザー名とパスワード付きのbasicにしてください
  • 403webhooks.collections_outside_keyこのAPIキーはコレクションに限定されています:Webhookのcollection_idsを指定し、そのすべてをキーのコレクションの中から選んでください
  • 404webhooks.delivery_not_foundWebhookの配信が見つかりません
  • 400webhooks.description_too_longWebhookの説明が200文字を超えています
  • 409webhooks.endpoint_disabledこのWebhookは無効になっています。先に有効にしてください
  • 409webhooks.event_not_permittedWebhookは現在このイベントを受信できません:ロール、データプロファイル、コレクション、またはタグで許可されなくなったため、配信は繰り返されません
  • 400webhooks.events_requiredイベントを一つ以上購読してください
  • 403webhooks.feature_disabledWebhookは組織のプランに含まれていません
  • 400webhooks.headers_invalidWebhookのカスタムヘッダーが無効です:ヘッダーは最大10個、名前は予約された名前以外の文字・数字・ハイフン、値は最大1024バイトにしてください
  • 400webhooks.invalid_urlWebhookのurlは、認証情報を含まない絶対httpsアドレスにしてください
  • 404webhooks.not_foundWebhookが見つかりません
  • 400webhooks.overlap_invalidローテーションの並行期間は0〜168時間にしてください
  • 400webhooks.private_addressWebhookのホストが、プライベートまたは予約済みのネットワークアドレスに解決されます
  • 400webhooks.redeliver_invalid再配信の期間は過去30日以内で、sinceはuntilより前にし、statusesはsuccess、exhausted、cancelledのいずれかにしてください
  • 409webhooks.too_many組織が持てるWebhookは最大20件です
  • 400webhooks.unknown_event不明なWebhookイベント{type}
  • 400webhooks.unresolvableWebhookのホストを解決できません