Common parameters

>>>

GET /api/common_parameters
List all global parameters

參數

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

頁數，從 1 開始

Validations:

  • Must be a number.
per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
domain_name
host_group_name
host_name
key_type
location_name
name
organization_name
os_name
parameter_type
subnet_name
type
value
>>>

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

參數

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

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
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[parameter_type]
必填

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
選填 , 允許空值

Validations:

  • Must be one of: true, false.
>>>

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

參數

參數名字 描述
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.
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[parameter_type]
選填

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
選填 , 允許空值

Validations:

  • Must be one of: true, false.
>>>

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

參數

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