GET /api/bookmarks
Lista alla bokmärken

Examples

GET /api/v2/bookmarks?page=1&per_page=10&search=
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 10,
  "search": "",
  "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
    }
  ]
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
Optional

filtrera resultat

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
controller string
name string

GET /api/bookmarks/:id
Visa ett bokmärke

Examples

GET /api/bookmarks/980190962-foo
200
{
  "name": "foo",
  "controller": "hosts",
  "query": "foo=boo",
  "public": true,
  "id": 980190962,
  "owner_id": null,
  "owner_type": null
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

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
Skapa ett bokmärke

Examples

POST /api/bookmarks
{
  "bookmark": {
    "public": false,
    "controller": "hosts",
    "name": "foo-bar",
    "query": "bar"
  }
}
201
{
  "name": "foo-bar",
  "controller": "hosts",
  "query": "bar",
  "public": false,
  "id": 980190963,
  "owner_id": 135138680,
  "owner_type": "User"
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

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

Validations:

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


PUT /api/bookmarks/:id
Uppdatera ett bokmärke

Examples

PUT /api/bookmarks/980190962-foo
{
  "bookmark": {
    "public": false,
    "controller": "hosts",
    "name": "facts.architecture",
    "query": " facts.architecture = x86_64"
  }
}
200
{
  "name": "facts.architecture",
  "controller": "hosts",
  "query": "facts.architecture = x86_64",
  "public": false,
  "id": 980190962,
  "owner_id": 135138680,
  "owner_type": "User"
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

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

Validations:

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


DELETE /api/bookmarks/:id
Radera ett bokmärke

Examples

DELETE /api/bookmarks/980190962-foo
{
  "bookmark": {}
}
200
{
  "id": 980190962,
  "name": "foo",
  "query": "foo=boo",
  "controller": "hosts",
  "public": true,
  "owner_id": null,
  "owner_type": null
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

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.