Api Documentation

>>>

GET /api/templates/:template_id/foreign_input_sets
List foreign input sets

Params

Param Name	Description
location_id Optional	Set the current location context for the request Validations: Must be a Integer
organization_id Optional	Set the current organization context for the request 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	filtra els resultats Validations: Must be a String
order Optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a 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$/`.

>>>

GET /api/templates/:template_id/foreign_input_sets/:id
Show foreign input set details

Params

Param Name	Description
location_id Optional	Set the current location context for the request Validations: Must be a Integer
organization_id Optional	Set the current organization context for the request 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/foreign_input_sets
Create a foreign input set

Params

Param Name	Description
location_id Optional	Set the current location context for the request Validations: Must be a Integer
organization_id Optional	Set the current organization context for the request 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.
foreign_input_set Required	Validations: Must be a Hash
foreign_input_set[target_template_id] Required	Target 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.
foreign_input_set[include_all] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	Include all inputs from the foreign template Validations: Must be one of: `true`, `false`, `1`, `0`.
foreign_input_set[include] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	A comma separated list of input names to be included from the foreign template. Validations: Must be a String
foreign_input_set[exclude] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	A comma separated list of input names to be included from the foreign template. Validations: Must be a String
foreign_input_set[description] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	Input set description Validations: Must be a String

>>>

DELETE /api/templates/:template_id/foreign_input_sets/:id
Delete a foreign input set

Params

Param Name	Description
location_id Optional	Set the current location context for the request Validations: Must be a Integer
organization_id Optional	Set the current organization context for the request 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/foreign_input_sets/:id
Update a foreign input set

Params

Param Name	Description
location_id Optional	Set the current location context for the request Validations: Must be a Integer
organization_id Optional	Set the current organization context for the request 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.
foreign_input_set Required	Validations: Must be a Hash
foreign_input_set[target_template_id] Optional	Target 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.
foreign_input_set[include_all] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	Include all inputs from the foreign template Validations: Must be one of: `true`, `false`, `1`, `0`.
foreign_input_set[include] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	A comma separated list of input names to be included from the foreign template. Validations: Must be a String
foreign_input_set[exclude] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	A comma separated list of input names to be included from the foreign template. Validations: Must be a String
foreign_input_set[description] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	Input set description Validations: Must be a String