GET /api/templates/:template_id/template_inputs
Показать параметры ввода

Параметры

Имя параметра Описание
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

template_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.

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
input_type
name

GET /api/templates/:template_id/template_inputs/: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

template_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.

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/templates/:template_id/template_inputs
Создать входной параметр

Параметры

Имя параметра Описание
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

template_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.

template_input
обязательно

Validations:

  • Must be a Hash

template_input[name]
обязательно

Имя параметра

Validations:

  • Must be a String

template_input[description]
необязательно , nil разрешен

Описание параметра

Validations:

  • Must be a String

template_input[required]
необязательно , nil разрешен

Обязательный параметр

Validations:

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

template_input[advanced]
необязательно , nil разрешен

Расширенный параметр

Validations:

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

template_input[input_type]
обязательно

Тип ввода

Validations:

  • Must be one of: user, fact, variable, puppet_parameter.

template_input[fact_name]
необязательно , nil разрешен

Имя факта (используется, если поле «Тип ввода» содержит «Значение факта»)

Validations:

  • Must be a String

template_input[variable_name]
необязательно , nil разрешен

Имя переменной (используется, если поле «Тип ввода» содержит «Переменная»)

Validations:

  • Must be a String

template_input[puppet_class_name]
необязательно , nil разрешен

Имя класса Puppet (используется, если поле «Тип ввода» содержит «Параметр Puppet»)

Validations:

  • Must be a String

template_input[puppet_parameter_name]
необязательно , nil разрешен

Имя параметра Puppet (используется, если поле «Тип ввода» содержит «Параметр Puppet»)

Validations:

  • Must be a String

template_input[options]
необязательно , nil разрешен

Список возможных значений

Validations:

  • Must be an array of any type

template_input[default]
необязательно , nil разрешен

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
необязательно , nil разрешен

The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

Validations:

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

template_input[value_type]
необязательно , nil разрешен

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date.

template_input[resource_type]
необязательно , nil разрешен

For values of type search, this is the resource the value searches in

Validations:

  • Must be one of: .


DELETE /api/templates/:template_id/template_inputs/: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

template_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.

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.


PUT /api/templates/:template_id/template_inputs/: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

template_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.

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.

template_input
обязательно

Validations:

  • Must be a Hash

template_input[name]
необязательно

Имя параметра

Validations:

  • Must be a String

template_input[description]
необязательно , nil разрешен

Описание параметра

Validations:

  • Must be a String

template_input[required]
необязательно , nil разрешен

Обязательный параметр

Validations:

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

template_input[advanced]
необязательно , nil разрешен

Расширенный параметр

Validations:

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

template_input[input_type]
необязательно

Тип ввода

Validations:

  • Must be one of: user, fact, variable, puppet_parameter.

template_input[fact_name]
необязательно , nil разрешен

Имя факта (используется, если поле «Тип ввода» содержит «Значение факта»)

Validations:

  • Must be a String

template_input[variable_name]
необязательно , nil разрешен

Имя переменной (используется, если поле «Тип ввода» содержит «Переменная»)

Validations:

  • Must be a String

template_input[puppet_class_name]
необязательно , nil разрешен

Имя класса Puppet (используется, если поле «Тип ввода» содержит «Параметр Puppet»)

Validations:

  • Must be a String

template_input[puppet_parameter_name]
необязательно , nil разрешен

Имя параметра Puppet (используется, если поле «Тип ввода» содержит «Параметр Puppet»)

Validations:

  • Must be a String

template_input[options]
необязательно , nil разрешен

Список возможных значений

Validations:

  • Must be an array of any type

template_input[default]
необязательно , nil разрешен

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
необязательно , nil разрешен

The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

Validations:

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

template_input[value_type]
необязательно , nil разрешен

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date.

template_input[resource_type]
необязательно , nil разрешен

For values of type search, this is the resource the value searches in

Validations:

  • Must be one of: .