Bookmarks

>>>

GET /api/bookmarks
List all bookmarks

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
search
Optional

filter results

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Tipo Possible values
controller string
name string
>>>

GET /api/bookmarks/:id
Show a bookmark

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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
Create a bookmark

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

PUT /api/bookmarks/:id
Update a bookmark

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

DELETE /api/bookmarks/:id
Delete a bookmark

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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.