Bookmarks

>>>

GET /api/bookmarks
Afficher tous les signets

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
controller
name
>>>

GET /api/bookmarks/:id
Afficher un signet

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
Créer un signet

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
bookmark
requis

Validations:

  • Must be a Hash
bookmark[name]
requis

Validations:

  • Must be a String
bookmark[controller]
requis

Validations:

  • Must be a String
bookmark[query]
requis

Validations:

  • Must be a String
bookmark[public]
optionel , nil autorisé

Validations:

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

PUT /api/bookmarks/:id
Mise à jour d'un signet

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
requis

Validations:

  • Must be a Hash
bookmark[name]
optionel

Validations:

  • Must be a String
bookmark[controller]
optionel

Validations:

  • Must be a String
bookmark[query]
optionel

Validations:

  • Must be a String
bookmark[public]
optionel , nil autorisé

Validations:

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

DELETE /api/bookmarks/:id
Supprimer un signet

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

Validations:

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