Bookmarks

>>>

GET /api/bookmarks
List all bookmarks.

Params

Param Name Description
page
Optional

paginate results

Validations:

  • Must be String
per_page
Optional

number of entries per request

Validations:

  • Must be String
>>>

GET /api/bookmarks/:id
Show a bookmark.

Params

Param Name Description
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
bookmark
Required

Validations:

  • Must be a Hash
bookmark[name]
Required

Validations:

  • Must be String
bookmark[controller]
Required

Validations:

  • Must be String
bookmark[query]
Required

Validations:

  • Must be String
bookmark[public]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'
>>>

PUT /api/bookmarks/:id
Update a bookmark.

Params

Param Name Description
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 String
bookmark[controller]
Optional

Validations:

  • Must be String
bookmark[query]
Optional

Validations:

  • Must be String
bookmark[public]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'
>>>

DELETE /api/bookmarks/:id
Delete a bookmark.

Params

Param Name Description
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.