GET /api/bookmarks 200 { "total": 2, "subtotal": 2, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "name": "foo", "controller": "hosts", "query": "foo=boo", "public": true, "id": 980190962, "owner_id": null, "owner_type": null }, { "name": "three", "controller": "hosts", "query": "three", "public": true, "id": 113629430, "owner_id": null, "owner_type": null } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort and order by a searchable field, e.g. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return, ‘all’ to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
controller | string | |
name | string |
GET /api/bookmarks/980190962-foo 200 { "name": "foo", "controller": "hosts", "query": "foo=boo", "public": true, "id": 980190962, "owner_id": null, "owner_type": null }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
POST /api/bookmarks { "bookmark": { "public": true, "controller": "hosts", "name": "foo-bar", "query": "bar" } } 201 { "name": "foo-bar", "controller": "hosts", "query": "bar", "public": true, "id": 980190964, "owner_id": 135138680, "owner_type": "User" }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
bookmark required |
Validations:
|
bookmark[name] required |
Validations:
|
bookmark[controller] required |
Validations:
|
bookmark[query] required |
Validations:
|
bookmark[public] optional , nil allowed |
Validations:
|
PUT /api/bookmarks/980190962 { "bookmark": { "public": false, "controller": "hosts", "name": "bookmark_5", "query": "bar" } } 422 { "error": { "id": 980190962, "errors": { "name": [ "has already been taken" ] }, "full_messages": [ "Name has already been taken" ] } }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
bookmark required |
Validations:
|
bookmark[name] optional |
Validations:
|
bookmark[controller] optional |
Validations:
|
bookmark[query] optional |
Validations:
|
bookmark[public] optional , nil allowed |
Validations:
|
DELETE /api/bookmarks/980190962-foo { "bookmark": {} } 200 { "id": 980190962, "name": "foo", "query": "foo=boo", "controller": "hosts", "public": true, "owner_id": null, "owner_type": null }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|