Template inputs

>>>

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

Examples

GET /api/templates/1007981803/template_inputs
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "template_id": 1007981803,
      "fact_name": null,
      "variable_name": null,
      "puppet_parameter_name": null,
      "puppet_class_name": null,
      "description": null,
      "required": false,
      "id": 2,
      "name": "Template input 3",
      "input_type": "user",
      "options": null
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
template_id
required

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
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

paginate results

Validations:

  • Must be a String
per_page
optional

number of entries per request

Validations:

  • Must be a String
>>>

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

Examples

GET /api/templates/1007981803-report_template42/template_inputs/2
200
{
  "template_id": 1007981803,
  "fact_name": null,
  "variable_name": null,
  "puppet_parameter_name": null,
  "puppet_class_name": null,
  "description": null,
  "required": false,
  "id": 2,
  "name": "Template input 7",
  "input_type": "user",
  "options": null
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
template_id
required

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
required

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
Create a template input

Examples

POST /api/templates/1007981803-report_template37/template_inputs
{
  "template_input": {
    "name": "is_potato",
    "input_type": "user",
    "options": [
      "true",
      "false"
    ]
  }
}
201
{
  "template_id": 1007981803,
  "fact_name": null,
  "variable_name": null,
  "puppet_parameter_name": null,
  "puppet_class_name": null,
  "description": null,
  "required": false,
  "id": 3,
  "name": "is_potato",
  "input_type": "user",
  "options": [
    "true",
    "false"
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
template_id
required

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
required

Validations:

  • Must be a Hash
template_input[name]
required

Input name

Validations:

  • Must be a String
template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be a 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, puppet_parameter.
template_input[fact_name]
optional , nil allowed

Fact name, used when input type is fact

Validations:

  • Must be a String
template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be a String
template_input[puppet_class_name]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String
template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String
template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type
>>>

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

Examples

DELETE /api/templates/1007981803-report_template41/template_inputs/2
{
  "template_input": {}
}
200
{
  "id": 2,
  "name": "Template input 6",
  "required": false,
  "input_type": "user",
  "fact_name": null,
  "variable_name": null,
  "puppet_class_name": null,
  "puppet_parameter_name": null,
  "description": null,
  "template_id": 1007981803,
  "created_at": "2018-11-15T19:02:26.996Z",
  "updated_at": "2018-11-15T19:02:26.996Z",
  "options": null,
  "advanced": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
template_id
required

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
required

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
Update a template input

Examples

PUT /api/templates/1007981803-report_template36/template_inputs/2
{
  "template_input": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 2,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
template_id
required

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
required

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
required

Validations:

  • Must be a Hash
template_input[name]
optional

Input name

Validations:

  • Must be a String
template_input[description]
optional , nil allowed

Input description

Validations:

  • Must be a 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, puppet_parameter.
template_input[fact_name]
optional , nil allowed

Fact name, used when input type is fact

Validations:

  • Must be a String
template_input[variable_name]
optional , nil allowed

Variable name, used when input type is variable

Validations:

  • Must be a String
template_input[puppet_class_name]
optional , nil allowed

Puppet class name, used when input type is puppet_parameter

Validations:

  • Must be a String
template_input[puppet_parameter_name]
optional , nil allowed

Puppet parameter name, used when input type is puppet_parameter

Validations:

  • Must be a String
template_input[options]
optional , nil allowed

Selectable values for user inputs

Validations:

  • Must be an array of any type