GET /api/bookmarks
Список всех закладок

Примеры

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
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
controller string
name string

GET /api/bookmarks/:id
Показать закладку

Примеры

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

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
Создать закладку

Примеры

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"
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

bookmark
обязательно

Validations:

  • Must be a Hash

bookmark[name]
обязательно

Validations:

  • Must be a String

bookmark[controller]
обязательно

Validations:

  • Must be a String

bookmark[query]
обязательно

Validations:

  • Must be a String

bookmark[public]
необязательно , nil разрешен

Validations:

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


PUT /api/bookmarks/:id
Изменить закладку

Примеры

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"
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
обязательно

Validations:

  • Must be a Hash

bookmark[name]
необязательно

Validations:

  • Must be a String

bookmark[controller]
необязательно

Validations:

  • Must be a String

bookmark[query]
необязательно

Validations:

  • Must be a String

bookmark[public]
необязательно , nil разрешен

Validations:

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


DELETE /api/bookmarks/:id
Удалить закладку

Примеры

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

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.