9.14 出力形式
APIを発行すると、APIの処理方式、APIの処理種別、実行結果に応じてレスポンスが返ります。
リクエストの処理が成功した場合のレスポンスの出力形式について次に示します。
|
APIの処理方式 |
APIの処理種別 |
実行結果のステータスコード |
出力形式 |
|---|---|---|---|
|
同期処理 |
GET（単一のオブジェクトの取得） |
200 |
各APIのレスポンスメッセージの説明を参照 |
|
GET（複数のオブジェクトの取得） |
200 |
データオブジェクト |
|
|
POST（リソースの作成） |
201 |
各APIのレスポンスメッセージの説明を参照 |
|
|
上記以外 |
200 |
各APIのレスポンスメッセージの説明を参照 |
|
|
非同期処理 |
すべて |
202 |
commandStatusオブジェクト |
リクエストの処理が失敗した場合は、レスポンスとしてエラーオブジェクトが返ります。