エラーとステータスコード

サポートされているすべてのステータスコードは、HTTP/1.1プロトコルに従います。HTTP/1.1ステータスコードを説明するリストについては、ステータスコードの定義を参照してください。

制限事項: ALM Octaneが特定の言語にローカライズされている場合でも、REST APIエラーメッセージが英語で表示される場合があります。

すべてのステータスコード

以下に、ALM Octaneでサポートされているステータスコードのリストを示します。

コード

名前

機能

200

OK
  • リクエストは成功しました

201

Created

  • リクエストは満たされました

  • 新しいリソースが作成されました

400

Bad Request

  • 構文が正しくないため、リクエストを理解できませんでした

  • クライアントは、再送信する前にリクエストの変更を実行する必要があります

  • PUTまたはPOST中に、設定できるフィールド値を制限する追加のロジックが満たされませんでした。このような場合、illegal_field_valueなどのプラットフォームエラーコードがエラーコード400とともに表示されます。

401

Unauthorized
  • リクエストにはユーザー認証が必要です

403

Forbidden

  • サーバーはリクエストを理解しました

  • サーバーはそれを実行することを拒否します

404

Not Found
  • サーバーがリクエストURIに一致するリソースを見つけられませんでした

405

Method Not Allowed
  • リクエストURIに一致するリソースにはリクエストメソッドは許可されていません

406

Not Acceptable
  • リクエストで提供されたAcceptフィールドヘッダーに従ってリソースを生成できません

408

Request Timeout
  • リクエストの処理中にHTTPプロトコルのタイムアウトが発生しました。サーブレットコンテナによって処理されます

409

Conflict

  • リクエストの競合が原因で、リクエストが部分的に実行されたか、完全に失敗しました

    リクエストが部分的に実行され、複数のエンティティがエラーで終了した場合、インデックス (entity_index) が返されます。 entity_indexは、エラーが参照するリクエスト「データ」配列内のエンティティのインデックスを示します。インデックスは1ではなく0から始まります。

  • テスト: ロックにより、テストスクリプトのリビジョンを作成できませんでした

415

Unsupported Media Type

  • サーバーはリクエストを理解しました

  • リクエストURIに一致するリソースによるリクエストメソッドでは、リクエスト形式はサポートされていません

500

Internal Server Error
  • サーバーが要求を実行できない状態に遭遇しました

501

Not Implemented

  • サーバーはリクエストメソッドを認識しません

  • サーバーは、リソースの要求メソッドをサポートできません
503 Service Unavailable

  • サーバーのメンテナンスのため、サーバーは現在リクエストを処理できません
 

トップに戻る

ログと相関ID

リクエストの処理中にエラーが発生した場合、ALM Octaneは詳細をログに送信します。詳細には、相関IDが含まれています。カスタマーサポートに連絡するときに相関IDを提供します。

{"error_code":"platform.general_error","correlation_id":"dn2wp6xe9qvgmsv8lvelp74r1","description":"General error occurred","description_translated":"General error occurred","properties":null}

トップに戻る

ビジネスエラープロパティ

名前の重複やエンティティのルール検証の失敗など、ビジネス上のエラーが発生した場合は、business_errorの値が応答に含まれる可能性があります。

次のコードは、返されたビジネスエラーの例を示しています。

{

"error_code": "platform.duplicate_entity_error",

"correlation_id": "yevz2e7v003q4f3g41wqp8qr1",

"description": "A release with this Name already exists.",

"business_error": true

}

where:

  • error_code。エラーの根本原因のより多くのコンテキストを提供するためにサポートに連絡するときに使用されるエラーコード値。
  • correlation_id。エラーが発生した操作の一意のID。サポートに連絡してエラーのコンテキストを提供するときに使用されます。この値を使用して、同じ操作中にログに記録されたすべてのOctaneサーバーログエントリを追跡できます。
  • description。エラーの簡単な説明。

  • business_error。ブール値。

    • trueは、ユーザー入力が正しくないことを示します。trueが返された場合は、APIを正しく使用していることを確認してください。
    • falseは、データベースへの接続が失われるなど、システムの予期しない状態を示します。falseが返された場合は、システム管理者に連絡して問題を報告する必要があります。

トップに戻る