Class ProjectTemplates

Index

Constructors

constructor

Methods

createProjectWithCustomTemplate editTemplate liveTemplate removeTemplate saveTemplate

Constructors

constructor

new ProjectTemplates(client: Client): Version3.ProjectTemplates
Parameters
- client: Client
Returns Version3.ProjectTemplates
- Defined in src/version3/projectTemplates.ts:8

Methods

createProjectWithCustomTemplate

createProjectWithCustomTemplate<T = unknown>(
parameters: Version3Parameters.CreateProjectWithCustomTemplate,
callback: Callback<T>,
): Promise<void>
Experimental
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreateProjectWithCustomTemplate
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectTemplates.ts:29
createProjectWithCustomTemplate<T = unknown>(
parameters: Version3Parameters.CreateProjectWithCustomTemplate,
callback?: undefined,
): Promise<T>
Experimental
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreateProjectWithCustomTemplate
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectTemplates.ts:52

editTemplate

editTemplate<T = unknown>(
parameters: Version3Parameters.EditTemplate,
callback: Callback<T>,
): Promise<void>
Experimental
Edit custom template

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

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.EditTemplate
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectTemplates.ts:81
editTemplate<T = unknown>(
parameters: Version3Parameters.EditTemplate,
callback?: undefined,
): Promise<T>
Experimental
Edit custom template

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

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.EditTemplate
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectTemplates.ts:91

liveTemplate

liveTemplate<T = Version3Models.ProjectTemplateModel>(
parameters: Version3Parameters.LiveTemplate,
callback: Callback<T>,
): Promise<void>
Experimental
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.
Type Parameters
- T = Version3Models.ProjectTemplateModel
Parameters
- parameters: Version3Parameters.LiveTemplate
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectTemplates.ts:116
liveTemplate<T = Version3Models.ProjectTemplateModel>(
parameters: Version3Parameters.LiveTemplate,
callback?: undefined,
): Promise<T>
Experimental
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.
Type Parameters
- T = Version3Models.ProjectTemplateModel
Parameters
- parameters: Version3Parameters.LiveTemplate
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectTemplates.ts:129

removeTemplate

removeTemplate<T = unknown>(
parameters: Version3Parameters.RemoveTemplate,
callback: Callback<T>,
): Promise<void>
Experimental
Remove custom template

This API endpoint allows you to remove a specified customised template

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.RemoveTemplate
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectTemplates.ts:158
removeTemplate<T = unknown>(
parameters: Version3Parameters.RemoveTemplate,
callback?: undefined,
): Promise<T>
Experimental
Remove custom template

This API endpoint allows you to remove a specified customised template

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.RemoveTemplate
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectTemplates.ts:168

saveTemplate

saveTemplate<T = Version3Models.SaveTemplateResponse>(
parameters: Version3Models.SaveTemplateRequest,
callback: Callback<T>,
): Promise<void>
Experimental
Save custom template

This API endpoint allows you to save a customised template

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = Version3Models.SaveTemplateResponse
Parameters
- parameters: Version3Models.SaveTemplateRequest
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectTemplates.ts:190
saveTemplate<T = Version3Models.SaveTemplateResponse>(
parameters: Version3Models.SaveTemplateRequest,
callback?: undefined,
): Promise<T>
Experimental
Save custom template

This API endpoint allows you to save a customised template

Note: Custom Templates are only supported for Jira Enterprise edition.
Type Parameters
- T = Version3Models.SaveTemplateResponse
Parameters
- parameters: Version3Models.SaveTemplateRequest
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectTemplates.ts:203

Class ProjectTemplates

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectTemplates

Methods

createProjectWithCustomTemplate

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

editTemplate

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

liveTemplate

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeTemplate

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

saveTemplate

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page