GET /api/bookmarks
すべてのブックマークを一覧表示

Params

Param Name Description
search
Optional

結果のフィルター

Validations:

  • Must be a String

order
Optional

結果のソート

Validations:

  • Must be a String

page
Optional

結果のページネーション

Validations:

  • Must be a String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be a 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 a String

bookmark[controller]
Required

Validations:

  • Must be a String

bookmark[query]
Required

Validations:

  • Must be a String

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

Validations:

  • Must be one of: true, false, 1, 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 a String

bookmark[controller]
Optional

Validations:

  • Must be a String

bookmark[query]
Optional

Validations:

  • Must be a String

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

Validations:

  • Must be one of: true, false, 1, 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.