Models

>>>

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]
選填 , 允許空值

Validations:

  • Must be a String
model[vendor_class]
選填 , 允許空值

Validations:

  • Must be a String
model[hardware_model]
選填 , 允許空值

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]
選填 , 允許空值

Validations:

  • Must be a String
model[vendor_class]
選填 , 允許空值

Validations:

  • Must be a String
model[hardware_model]
選填 , 允許空值

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