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

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

filtrera resultat

Validations:

  • Must be a String

order
optional

sortera resultat

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

antal poster per begäran

Validations:

  • Must be a String


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

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/foreign_input_sets
Create a foreign input set

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.

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

Include all inputs from the foreign template

Validations:

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

foreign_input_set[include]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • Must be a String

foreign_input_set[exclude]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • Must be a String

foreign_input_set[description]
optional , nil allowed

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

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/foreign_input_sets/:id
Update a foreign input set

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.

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

Include all inputs from the foreign template

Validations:

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

foreign_input_set[include]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • Must be a String

foreign_input_set[exclude]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • Must be a String

foreign_input_set[description]
optional , nil allowed

Input set description

Validations:

  • Must be a String