project-template

create-project-with-custom-template

Create custom project

Creates a project based on a custom template provided in the request.

The request body should contain the project details and the capabilities that comprise the project:

• details - represents the project details settings
• template - represents a list of capabilities responsible for creating specific parts of a project

A capability is defined as a unit of configuration for the project you want to create.

This operation is:

• asynchronous. Follow the Location link in the response header to determine the status of the task and use Get task to obtain subsequent updates.

Note: This API is only supported for Jira Enterprise edition.

POST /rest/api/3/project-template

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr project-template create-project-with-custom-template

edit-template

Edit a custom project template

Edit custom template

This API endpoint allows you to edit an existing customised template.

Note: Custom Templates are only supported for Jira Enterprise edition.

PUT /rest/api/3/project-template/edit-template

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr project-template edit-template

live-template

Gets a custom project template

Get custom template

This API endpoint allows you to get a live custom project template details by either templateKey or projectId

Note: Custom Templates are only supported for Jira Enterprise edition.

GET /rest/api/3/project-template/live-template

Flag	Type	Required	Description
--projectId	string	No	optional - The {@link String} containing the project key linked to the custom template to retrieve
--templateKey	string	No	optional - The {@link String} containing the key of the custom template to retrieve

Example:

jr project-template live-template

remove-template

Deletes a custom project template

Remove custom template

This API endpoint allows you to remove a specified customised template

Note: Custom Templates are only supported for Jira Enterprise edition.

DELETE /rest/api/3/project-template/remove-template

Flag	Type	Required	Description
--templateKey	string	No	The {@link String} containing the key of the custom template to remove

Example:

jr project-template remove-template

save-template

Save a custom project template

Save custom template

This API endpoint allows you to save a customised template

Note: Custom Templates are only supported for Jira Enterprise edition.

POST /rest/api/3/project-template/save-template

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr project-template save-template