GET /api/templates/:template_id/template_inputs
Listar entradas de la plantilla

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
requerido

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
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
input_type
name

GET /api/templates/:template_id/template_inputs/:id
Mostrar detalles de entrada de la plantilla

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
requerido

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
requerido

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
Crear una entrada de la plantilla

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
requerido

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
requerido

Validations:

  • Must be a Hash

template_input[name]
requerido

Nombre de la entrada

Validations:

  • Must be a String

template_input[description]
opcional , nil permitido

Descripción de la entrada

Validations:

  • Must be a String

template_input[required]
opcional , nil permitido

La entrada es obligatoria.

Validations:

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

template_input[advanced]
opcional , nil permitido

La entrada es avanzada.

Validations:

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

template_input[input_type]
requerido

Tipo de entrada

Validations:

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

template_input[fact_name]
opcional , nil permitido

Nombre del evento, utilizado cuando el tipo de entrada es evento

Validations:

  • Must be a String

template_input[variable_name]
opcional , nil permitido

Nombre de la variable, utilizada cuando el tipo de entrada es variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opcional , nil permitido

Nombre de clase Puppet, utilizado cuando el tipo de entrada es puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opcional , nil permitido

Nombre de parámetro Puppet, utilizado cuando el tipo de entrada es puppet_parameter

Validations:

  • Must be a String

template_input[options]
opcional , nil permitido

Valores que se pueden seleccionar para entradas de usuario

Validations:

  • Must be an array of any type

template_input[default]
opcional , nil permitido

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opcional , nil permitido

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]
opcional , nil permitido

Value type, defaults to plain

Validations:

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

template_input[resource_type]
opcional , nil permitido

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
Eliminar una entrada de la plantilla

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
requerido

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
requerido

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
Actualizar una entrada de la plantilla

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

template_id
requerido

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
requerido

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
requerido

Validations:

  • Must be a Hash

template_input[name]
opcional

Nombre de la entrada

Validations:

  • Must be a String

template_input[description]
opcional , nil permitido

Descripción de la entrada

Validations:

  • Must be a String

template_input[required]
opcional , nil permitido

La entrada es obligatoria.

Validations:

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

template_input[advanced]
opcional , nil permitido

La entrada es avanzada.

Validations:

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

template_input[input_type]
opcional

Tipo de entrada

Validations:

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

template_input[fact_name]
opcional , nil permitido

Nombre del evento, utilizado cuando el tipo de entrada es evento

Validations:

  • Must be a String

template_input[variable_name]
opcional , nil permitido

Nombre de la variable, utilizada cuando el tipo de entrada es variable

Validations:

  • Must be a String

template_input[puppet_class_name]
opcional , nil permitido

Nombre de clase Puppet, utilizado cuando el tipo de entrada es puppet_parameter

Validations:

  • Must be a String

template_input[puppet_parameter_name]
opcional , nil permitido

Nombre de parámetro Puppet, utilizado cuando el tipo de entrada es puppet_parameter

Validations:

  • Must be a String

template_input[options]
opcional , nil permitido

Valores que se pueden seleccionar para entradas de usuario

Validations:

  • Must be an array of any type

template_input[default]
opcional , nil permitido

Default value for user input

Validations:

  • Must be a String

template_input[hidden_value]
opcional , nil permitido

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]
opcional , nil permitido

Value type, defaults to plain

Validations:

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

template_input[resource_type]
opcional , nil permitido

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

Validations:

  • Must be one of: .