GET /api/bookmarks
ブックマーク一覧

Params

Param Name Description
search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

リクエストあたりのエントリ数

Validations:

  • Must be String


GET /api/bookmarks/:id
ブックマークの表示

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/bookmarks
ブックマークの作成

Params

Param Name Description
bookmark
Required

Validations:

  • Must be a Hash

bookmark[name]
Required

Validations:

  • Must be String

bookmark[controller]
Required

Validations:

  • Must be String

bookmark[query]
Required

Validations:

  • Must be String

bookmark[public]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'


PUT /api/bookmarks/:id
ブックマークの更新

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

bookmark
Required

Validations:

  • Must be a Hash

bookmark[name]
Optional

Validations:

  • Must be String

bookmark[controller]
Optional

Validations:

  • Must be String

bookmark[query]
Optional

Validations:

  • Must be String

bookmark[public]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'


DELETE /api/bookmarks/:id
ブックマークの削除

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.