GET /api/bookmarks
모든 북마크 목록 나열

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optional

필터 결과

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

Search fields

Field name 유형 Possible values
controller
name

GET /api/bookmarks/:id
북마크 표시

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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 , nil allowed

Validations:

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


PUT /api/bookmarks/:id
북마크 업데이트

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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 , nil allowed

Validations:

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


DELETE /api/bookmarks/:id
북마크 삭제

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.