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

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

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

페이지네이션 결과

Validations:

  • Must be a String

per_page
Optional

요청 당 항목 수

Validations:

  • Must be a String

Search fields

Field name 유형 Possible values
controller string
name string

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

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

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

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

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


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

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

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


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

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

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.