GET /api/job_templates
List job templates

GET /api/locations/:location_id/job_templates
List job templates per location

GET /api/organizations/:organization_id/job_templates
List job templates per organization

Params

Param Name Description
search
Optional

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por requisições


Value: Must be String

GET /api/job_templates/:id
Show job template details

Params

Param Name Description
id
Required

Value: 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/job_templates
Create a job template

Params

Param Name Description
job_template
Required

Value: Must be a Hash
job_template[name]
Required

Template name


Value: Must be String
job_template[job_name]
Required

Job name


Value: Must be String
job_template[template]
Required

Value: Must be String
job_template[provider_type]
Required

Provider type


Value: Must be String
job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
job_template[locked]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Whether or not the template is locked for editing


Value: Must be 'true' or 'false'

PUT /api/job_templates/:id
Update a job template

Params

Param Name Description
id
Required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
job_template
Required

Value: Must be a Hash
job_template[name]
Optional

Template name


Value: Must be String
job_template[job_name]
Optional

Job name


Value: Must be String
job_template[template]
Optional

Value: Must be String
job_template[provider_type]
Optional

Provider type


Value: Must be String
job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
job_template[locked]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Whether or not the template is locked for editing


Value: Must be 'true' or 'false'

GET /api/job_templates/revision

Params

Param Name Description
version
Optional

Template version


Value: Must be String

DELETE /api/job_templates/:id
Delete a job template

Params

Param Name Description
id
Required

Value: 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/job_templates/:id/clone
Clone a provision template

Params

Param Name Description
id
Required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
job_template
Required

Value: Must be a Hash
job_template[name]
Required

Template name


Value: Must be String