GET /api/bookmarks
Listar todos los marcadores

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
controller
name

GET /api/bookmarks/:id
Mostrar un marcador

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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
Crear un marcador

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

bookmark
requerido

Validations:

  • Must be a Hash

bookmark[name]
requerido

Validations:

  • Must be a String

bookmark[controller]
requerido

Validations:

  • Must be a String

bookmark[query]
requerido

Validations:

  • Must be a String

bookmark[public]
opcional , nil permitido

Validations:

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


PUT /api/bookmarks/:id
Actualizar un marcador

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

bookmark[name]
opcional

Validations:

  • Must be a String

bookmark[controller]
opcional

Validations:

  • Must be a String

bookmark[query]
opcional

Validations:

  • Must be a String

bookmark[public]
opcional , nil permitido

Validations:

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


DELETE /api/bookmarks/:id
Borrar un marcador

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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