Common parameters

>>>

GET /api/common_parameters
列出所有全局参数

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

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
选填

编页结果

Validations:

  • Must be a String
per_page
选填

每个请求中的条目数

Validations:

  • Must be a String

搜索字段

字段名 类型 可能的值
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
选填

显示隐藏值

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.