GET /api/common_parameters
List all global parameters

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

show_hidden
選填

Display hidden values

Validations:

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

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

編頁結果

Validations:

  • Must be a String

per_page
選填

每個請求的項目數量

Validations:

  • Must be a String

Search fields

Field name 類型 Possible values
domain_name string
host_group_name string
host_name string
location_name string
name string
organization_name string
os_name string
subnet_name text
type string
value text

GET /api/common_parameters/:id
顯示全域參數

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

show_hidden
選填

Display hidden values

Validations:

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

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/common_parameters
建立全域參數

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

common_parameter
必填

Validations:

  • Must be a Hash

common_parameter[name]
必填

Validations:

  • Must be a String

common_parameter[value]
必填

Validations:

  • Must be a String

common_parameter[hidden_value]
選填 , 允許空值

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
更新全域參數

參數

參數名字 描述
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.

common_parameter
必填

Validations:

  • Must be a Hash

common_parameter[name]
選填

Validations:

  • Must be a String

common_parameter[value]
選填

Validations:

  • Must be a String

common_parameter[hidden_value]
選填 , 允許空值

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
刪除全域參數

參數

參數名字 描述
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.