エラー

失敗したリクエストは、HTTPエラーステータスと error オブジェクトを返します。

{
  "error": {
    "code": "PROJECT_NOT_FOUND_EXCEPTION",
    "message": "プロジェクトが見つかりません。"
  }
}

フィールド	説明
error.code	エラーコード。どの言語でも同じ値のため、この値で処理を分岐してください
error.message	ユーザーに表示できる説明
error.details	追加情報。一部のエラーでのみ含まれます

たとえば、無効なリクエストボディでは、最初の無効なフィールドが error.details.property に示されます。

{
  "error": {
    "code": "INVALID_REQUEST_BODY_EXCEPTION",
    "message": "リクエストの値が無効です。",
    "details": {
      "property": "keyword"
    }
  }
}

リクエストID

すべてのレスポンスは、X-YouViCo-Request-Id ヘッダーに16進数32文字のIDを含みます。

X-YouViCo-Request-Id: 4bf92f3577b34da6a3ce929d0e0e4736

失敗したリクエストではこの値も記録し、エラーをお問い合わせいただく際にお伝えいただけます。

HTTPステータスコード

ステータス	意味
400 Bad Request	フィールドが不足しているか無効、またはカーソルの形式が不正
401 Unauthorized	APIキーまたはOAuthアクセストークンがない、無効、または有効期限切れ
403 Forbidden	この操作を行う権限がない
404 Not Found	リソースが存在しない、またはアクセスできない
409 Conflict	リクエストが現在の状態と競合する（リアクションの重複など）
413 Content Too Large	リクエストボディが大きすぎる
415 Unsupported Media Type	リクエストボディをJSONで送っていない
429 Too Many Requests	レート制限を超えた
500 Internal Server Error	サーバー側で問題が発生した
503 Service Unavailable	サービスがメンテナンス中

共通エラーコード

次のエラーはすべてのエンドポイントで発生する可能性があります。

コード	ステータス	発生条件
INVALID_REQUEST_BODY_EXCEPTION	400	リクエストボディが無効、またはカーソルの形式が不正
INVALID_REQUEST_EXCEPTION	400	無効なリクエスト
INVALID_AUTHENTICATION_HEADER_EXCEPTION	400	AuthorizationヘッダーがBearer YOUR_API_KEYの形式ではない
INVALID_API_KEY_EXCEPTION	401	APIキーが存在しない、または有効でなくなった
INVALID_ACCESS_TOKEN_EXCEPTION	401	OAuthアクセストークンが無効、または有効期限切れ
ACCESS_DENIED_EXCEPTION	403	リソースへのアクセス権がない
FORBIDDEN_SCOPE_EXCEPTION	403	エンドポイントに必要なスコープがキーまたは連携にない
FORBIDDEN_ROLE_EXCEPTION	403	ロールでこの操作が許可されていない
USER_SUSPENDED_EXCEPTION	403	停止されたアカウント
NOT_IN_WORKSPACE_EXCEPTION	403	ワークスペースのメンバーではない
FORBIDDEN_STATUS_EXCEPTION	403	無効なワークスペースメンバー
PROJECT_ARCHIVED_EXCEPTION	403	プロジェクトがアーカイブされており、変更できない
ROUTE_NOT_FOUND_EXCEPTION	404	URLパスがエンドポイントではない
WORKSPACE_NOT_FOUND_EXCEPTION	404	存在しないワークスペース
REQUEST_BODY_SIZE_LIMIT_EXCEEDED_EXCEPTION	413	リクエストボディが大きすぎる
UNSUPPORTED_CONTENT_TYPE_EXCEPTION	415	リクエストボディをapplication/jsonで送っていない
RATE_LIMIT_EXCEEDED_EXCEPTION	429	エンドポイントのレート制限を超えた
INTERNAL_UNEXPECTED_EXCEPTION	500	予期しないサーバーエラーが発生した
DATABASE_UNAVAILABLE_EXCEPTION	500	現在リクエストを処理できない。しばらくしてから再試行する
SERVICE_MAINTENANCE_EXCEPTION	503	サービスがメンテナンス中