GET /api/models
Список всего оборудования

Примеры

GET /api/models?include_permissions=true
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "can_create": true,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "info": "Virtual Machine",
      "created_at": "2019-09-11 10:40:36 -0400",
      "updated_at": "2019-09-11 10:40:36 -0400",
      "vendor_class": null,
      "hardware_model": null,
      "id": 980190962,
      "name": "KVM",
      "can_edit": true,
      "can_delete": true,
      "hosts_count": 0
    },
    {
      "info": null,
      "created_at": "2019-09-11 10:40:36 -0400",
      "updated_at": "2019-09-11 10:40:36 -0400",
      "vendor_class": "Sun-Fire-V210",
      "hardware_model": "SUN4U",
      "id": 139037058,
      "name": "SUN V210",
      "can_edit": true,
      "can_delete": true,
      "hosts_count": 0
    }
  ]
}

Параметры

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

Ограничить местоположением

Validations:

  • Must be a Integer

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

Ограничить организацией

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
hardware_model string
info text
name string
vendor_class string

GET /api/models/:id
Показать оборудование

Примеры

GET /api/models/980190962-KVM
200
{
  "info": "Virtual Machine",
  "created_at": "2019-09-11 14:48:32 UTC",
  "updated_at": "2019-09-11 14:48:32 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190962,
  "name": "KVM",
  "can_edit": true,
  "can_delete": true,
  "hosts_count": 0
}

Параметры

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

Ограничить местоположением

Validations:

  • Must be a Integer

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

Ограничить организацией

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/models
Создать оборудование

Примеры

POST /api/models
{
  "model": {
    "name": "new model"
  }
}
201
{
  "info": null,
  "created_at": "2019-09-11 14:48:52 UTC",
  "updated_at": "2019-09-11 14:48:52 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190965,
  "name": "new model",
  "hosts_count": 0
}

Параметры

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

Ограничить местоположением

Validations:

  • Must be a Integer

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

Ограничить организацией

Validations:

  • Must be a Integer

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String


PUT /api/models/:id
Изменить оборудование

Примеры

PUT /api/models/980190962-KVM
{
  "name": "KVM",
  "model": {
    "name": "KVM"
  }
}
200
{
  "info": "Virtual Machine",
  "created_at": "2019-09-11 14:48:32 UTC",
  "updated_at": "2019-09-11 14:48:32 UTC",
  "vendor_class": null,
  "hardware_model": null,
  "id": 980190962,
  "name": "KVM",
  "hosts_count": 0
}

Параметры

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

Ограничить местоположением

Validations:

  • Must be a Integer

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

Ограничить организацией

Validations:

  • Must be a Integer

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

Validations:

  • Must be a String

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String

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

Validations:

  • Must be a String


DELETE /api/models/:id
Удалить оборудование

Примеры

DELETE /api/models/980190962-KVM
{
  "model": {}
}
200
{
  "id": 980190962,
  "name": "KVM",
  "info": "Virtual Machine",
  "created_at": "2019-09-11T14:48:32.036Z",
  "updated_at": "2019-09-11T14:48:32.036Z",
  "vendor_class": null,
  "hardware_model": null
}

Параметры

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

Ограничить местоположением

Validations:

  • Must be a Integer

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

Ограничить организацией

Validations:

  • Must be a Integer

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

Validations:

  • Must be a String