Class ProjectTemplatesService

This resource represents project templates. Use it to create a new project from a custom template.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-templates

Hierarchy

  • CommonHttpService
    • ProjectTemplatesService

Constructors

constructor

Methods

createProjectWithCustomTemplate editTemplate liveTemplate removeTemplate saveTemplate initialize

Constructors

constructor

  • new ProjectTemplatesService(getClientInstance): ProjectTemplatesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns ProjectTemplatesService

Methods

createProjectWithCustomTemplate

  • createProjectWithCustomTemplate(params): Promise<void>

  • 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.

    Permissions required: Administer Jira global permission.

    Parameters

    Returns Promise<void>

    Path

    POST /rest/api/3/project-template @scopes-current manage:jira-configuration @scopes-beta write:project:jira, read:project:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-templates#api-rest-api-3-project-template-post

editTemplate

liveTemplate

  • liveTemplate(params?): Promise<ProjectTemplateModel>

  • 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.

    Parameters

    • params: {
          projectId?: string;
          templateKey?: string;
      } = {}
      • OptionalprojectId?: string

        optional - The {@link String} containing the project key linked to the custom template to retrieve

      • OptionaltemplateKey?: string

        optional - The {@link String} containing the key of the custom template to retrieve

    Returns Promise<ProjectTemplateModel>

    200 response

    Path

    GET /rest/api/3/project-template/live-template @scopes-current manage:jira-configuration @scopes-beta write:project:jira, read:project:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-templates#api-rest-api-3-project-template-live-template-get

removeTemplate

saveTemplate

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods