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

Params

Param Name Description
template_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.

search
Optional

filter results


Value:

Must be String

order
Optional

sort results


Value:

Must be String

page
Optional

paginate results


Value:

Must be String

per_page
Optional

number of entries per request


Value:

Must be String


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

Params

Param Name Description
template_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.

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

Params

Param Name Description
template_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.

foreign_input_set
Required

Value:

Must be a Hash

foreign_input_set[target_template_id]
Required

Target template ID


Value:

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: gl.apipie.nil_allowed">Nil Allowed</span>

Include all inputs form the foreign template


Value:

Must be 'true' or 'false'

foreign_input_set[include]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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


Value:

Must be String

foreign_input_set[exclude]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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


Value:

Must be String

foreign_input_set[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Input set description


Value:

Must be String


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

Params

Param Name Description
template_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.

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.


PUT /api/templates/:template_id/foreign_input_sets/:id
Update a foreign input set

Params

Param Name Description
template_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.

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.

foreign_input_set
Required

Value:

Must be a Hash

foreign_input_set[target_template_id]
Optional

Target template ID


Value:

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: gl.apipie.nil_allowed">Nil Allowed</span>

Include all inputs form the foreign template


Value:

Must be 'true' or 'false'

foreign_input_set[include]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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


Value:

Must be String

foreign_input_set[exclude]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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


Value:

Must be String

foreign_input_set[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Input set description


Value:

Must be String