RESTful API エンドポイント (delete)

deleteエンドポイントについて

オブジェクトを削除します。認証付きリクエストでログイン中のユーザーがそのオブジェクトに対する削除権限が必要です。

エンドポイント(entryモデルの例)

/api/v1/スコープID/モデル名/delete/オブジェクトID
/api/v1/1/entry/delete/1

メソッド

DELETE または POST

リクエストボディ

なし

レスポンス(成功時)

オブジェクトの idとリクエストボディの JSONで指定したキーの値を返します。

{
    "Success": 1
}

レスポンス・エラー

共通レスポンスエラーについてはこちら を参照ください。

許可されないリクエストメソッド

{
    "status": 400,
    "message": "Method リクエストメソッド not allowed."
}

該当するオブジェクトが存在しない

{
    "status": 404,
    "message": "The モデル名 was not found."
}

認証付きリクエストでないか、有効なユーザーではない、権限がない

{
    "status": 403,
    "message": "Permission denied."
}

JSONにキー「workspace_id」指定があって、実行中のスコープと異なる

{
    "status": 403,
    "message": "Invalid workspace_id specified."
}

バリデーション・エラー

  • Required(必須)
  • Invalid(バリデーションエラー)
  • Duplicate(ユニークカラムの重複)

各々をキーとしてカラム名とエラーメッセージの配列を errorsにセットして返します。

プラグインなどのコールバックによって deleteがキャンセルされた

{
    "status": 406,
    "message": "Delete canceled by callback(エラー内容)."
}

オブジェクトの削除に失敗した

{
    "status": 500,
    "message": "An error occurred while delete object."
}