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]
необязательно , 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.