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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
controller
name

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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

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
ブックマークの作成

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

bookmark
必須

Validations:

  • Must be a Hash

bookmark[name]
必須

Validations:

  • Must be a String

bookmark[controller]
必須

Validations:

  • Must be a String

bookmark[query]
必須

Validations:

  • Must be a String

bookmark[public]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.


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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

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
必須

Validations:

  • Must be a Hash

bookmark[name]
任意

Validations:

  • Must be a String

bookmark[controller]
任意

Validations:

  • Must be a String

bookmark[query]
任意

Validations:

  • Must be a String

bookmark[public]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.


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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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