API documentation

>>>

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 , nil allowed	Include all inputs form the foreign template Value: Must be ‘true’ or ‘false’
foreign_input_set[include] optional , nil allowed	A comma separated list of input names to be included from the foreign template. Value: Must be String
foreign_input_set[exclude] optional , nil allowed	A comma separated list of input names to be included from the foreign template. Value: Must be String
foreign_input_set[description] optional , nil allowed	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 , nil allowed	Include all inputs form the foreign template Value: Must be ‘true’ or ‘false’
foreign_input_set[include] optional , nil allowed	A comma separated list of input names to be included from the foreign template. Value: Must be String
foreign_input_set[exclude] optional , nil allowed	A comma separated list of input names to be included from the foreign template. Value: Must be String
foreign_input_set[description] optional , nil allowed	Input set description Value: Must be String