GET /api/bookmarks
List all bookmarks

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
controller string
name string

GET /api/bookmarks/:id
Show a bookmark

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/bookmarks
Create a bookmark

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

bookmark
required

Validations:

  • Hash

bookmark[name]
required

Validations:

  • String

bookmark[controller]
required

Validations:

  • String

bookmark[query]
required

Validations:

  • String

bookmark[public]
optional , nil allowed

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:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

bookmark
required

Validations:

  • Hash

bookmark[name]
optional

Validations:

  • String

bookmark[controller]
optional

Validations:

  • String

bookmark[query]
optional

Validations:

  • String

bookmark[public]
optional , nil allowed

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:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..