Templates

>>>

GET /api/v1/templates
Display a list of all templates available in the application.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

GET /api/v1/templates/:id
Display a template.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the template to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/templates
Create a new template.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
template
optional , nil allowed

Validations:

  • Must be a Hash
template[name]
required

Name of the template.

Validations:

  • Must be a String
template[template_type]
required

The type of the template, e.g. ‘generic’, ‘avid’, ‘adobe’

Validations:

  • Must be a String
substitution_patterns
optional

An array of SubstitutionPattern objects.

Validations:

  • Must be an Array of nested elements
substitution_patterns[substitution_pattern]
optional

Validations:

  • Must be a Hash
substitution_patterns[substitution_pattern][token]
required

The string to search for.

Validations:

  • Must be a String
substitution_patterns[substitution_pattern][pattern]
required

The string to replace token with. It may contain several special sequences like %n that will be interpreted when a project is created.

Validations:

  • Must be a String
>>>

POST /api/v1/templates/:id/duplicate
Create a new copy of an existing template.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the template to be duplicated.

Validations:

  • Must be a String
>>>

PUT /api/v1/templates/:id
Update a template.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the template to be updated.

Validations:

  • Must be a String
template
optional , nil allowed

Validations:

  • Must be a Hash
template[name]
optional

Name of the template.

Validations:

  • Must be a String
template[template_type]
optional

The type of the template, e.g. ‘generic’, ‘avid’, ‘adobe’

Validations:

  • Must be a String
substitution_patterns
optional

An array of SubstitutionPattern objects.

Validations:

  • Must be an Array of nested elements
substitution_patterns[substitution_pattern]
optional

Validations:

  • Must be a Hash
substitution_patterns[substitution_pattern][token]
required

The string to search for.

Validations:

  • Must be a String
substitution_patterns[substitution_pattern][pattern]
required

The string to replace token with. It may contain several special sequences like %n that will be interpreted when a project is created.

Validations:

  • Must be a String
>>>

DELETE /api/v1/templates/:id
Delete a template.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the template to be deleted.

Validations:

  • Must be a String
ignore_missing_directory
optional
true | false

Indicates whether missing template directory should raise errors on delete. Default: false.

Validations:

  • Must be a String
>>>

GET /api/v1/template_types
Display a list of all template types available in the application.

Metadata

- Authentication: The user must be authenticated to perform this action.