GET /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

show_hidden
任意

非表示の値の表示

Validations:

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

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
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
任意

非表示の値の表示

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]
任意 , nil可

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]
任意 , nil可

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.