Template inputs

>>>

GET /api/templates/:template_id/template_inputs
List template inputs

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
id integer
input_type string
name string
>>>

GET /api/templates/:template_id/template_inputs/:id
Show template input details

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/templates/:template_id/template_inputs
Create a template input

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
template_input
required

Validations:

  • Hash
template_input[name]
required

Input name

Validations:

  • String
template_input[description]
optional , nil allowed

Input description

Validations:

  • String
template_input[required]
optional , nil allowed

Input is required

Validations:

  • Must be one of: true, false, 1, 0.
template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be one of: true, false, 1, 0.
template_input[input_type]
required

Input type

Validations:

  • Must be one of: user, fact, variable.
template_input[fact_name]
optional , nil allowed

Fact name, used when input type is Fact value

Validations:

  • String
template_input[variable_name]
optional , nil allowed

Variable name, used when input type is Variable

Validations:

  • String
template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type
template_input[default]
optional , nil allowed

Default value for user input

Validations:

  • String
template_input[hidden_value]
optional , nil allowed

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]
optional , nil allowed

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date, resource.
template_input[resource_type]
optional , nil allowed

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

Validations:

  • Must be one of: Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigReport, Domain, ExternalUsergroup, FactValue, Filter, ForemanTasks::RecurringLogic, ForemanTasks::Task, Host, Hostgroup, HttpProxy, Image, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::AlternateContentSource, Katello::ContentCredential, Katello::ContentView, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Realm, RemoteExecutionFeature, ReportTemplate, Role, Setting, SmartProxy, SshKey, Subnet, TemplateInvocation, User, Usergroup.
>>>

DELETE /api/templates/:template_id/template_inputs/:id
Delete a template input

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /api/templates/:template_id/template_inputs/:id
Update a template input

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
template_input
required

Validations:

  • Hash
template_input[name]
optional

Input name

Validations:

  • String
template_input[description]
optional , nil allowed

Input description

Validations:

  • String
template_input[required]
optional , nil allowed

Input is required

Validations:

  • Must be one of: true, false, 1, 0.
template_input[advanced]
optional , nil allowed

Input is advanced

Validations:

  • Must be one of: true, false, 1, 0.
template_input[input_type]
optional

Input type

Validations:

  • Must be one of: user, fact, variable.
template_input[fact_name]
optional , nil allowed

Fact name, used when input type is Fact value

Validations:

  • String
template_input[variable_name]
optional , nil allowed

Variable name, used when input type is Variable

Validations:

  • String
template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type
template_input[default]
optional , nil allowed

Default value for user input

Validations:

  • String
template_input[hidden_value]
optional , nil allowed

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]
optional , nil allowed

Value type, defaults to plain

Validations:

  • Must be one of: plain, search, date, resource.
template_input[resource_type]
optional , nil allowed

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

Validations:

  • Must be one of: Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigReport, Domain, ExternalUsergroup, FactValue, Filter, ForemanTasks::RecurringLogic, ForemanTasks::Task, Host, Hostgroup, HttpProxy, Image, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::AlternateContentSource, Katello::ContentCredential, Katello::ContentView, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Realm, RemoteExecutionFeature, ReportTemplate, Role, Setting, SmartProxy, SshKey, Subnet, TemplateInvocation, User, Usergroup.