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
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
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]
選填 , 允許空值

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]
選填 , 允許空值

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.