Class IssueTypeSchemes

Index

Constructors

Methods

addIssueTypesToIssueTypeScheme assignIssueTypeSchemeToProject createIssueTypeScheme deleteIssueTypeScheme getAllIssueTypeSchemes getIssueTypeSchemeForProjects getIssueTypeSchemesMapping removeIssueTypeFromIssueTypeScheme reorderIssueTypesInIssueTypeScheme updateIssueTypeScheme

Constructors

constructor

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

Methods

addIssueTypesToIssueTypeScheme

addIssueTypesToIssueTypeScheme<T = void>(
parameters: Version3Parameters.AddIssueTypesToIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Adds issue types to an issue type scheme.

The added issue types are appended to the issue types list.

If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddIssueTypesToIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:307
addIssueTypesToIssueTypeScheme<T = void>(
parameters: Version3Parameters.AddIssueTypesToIssueTypeScheme,
callback?: undefined,
): Promise<T>
Adds issue types to an issue type scheme.

The added issue types are appended to the issue types list.

If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddIssueTypesToIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:321

assignIssueTypeSchemeToProject

assignIssueTypeSchemeToProject<T = void>(
parameters: Version3Parameters.AssignIssueTypeSchemeToProject,
callback: Callback<T>,
): Promise<void>
Assigns an issue type scheme to a project.

If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

Issue type schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AssignIssueTypeSchemeToProject
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:191
assignIssueTypeSchemeToProject<T = void>(
parameters: Version3Parameters.AssignIssueTypeSchemeToProject,
callback?: undefined,
): Promise<T>
Assigns an issue type scheme to a project.

If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

Issue type schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AssignIssueTypeSchemeToProject
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:206

createIssueTypeScheme

createIssueTypeScheme<T = Version3Models.IssueTypeSchemeID>(
parameters: Version3Parameters.CreateIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Creates an issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeSchemeID
Parameters
- parameters: Version3Parameters.CreateIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:62
createIssueTypeScheme<T = Version3Models.IssueTypeSchemeID>(
parameters: Version3Parameters.CreateIssueTypeScheme,
callback?: undefined,
): Promise<T>
Creates an issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeSchemeID
Parameters
- parameters: Version3Parameters.CreateIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:72

deleteIssueTypeScheme

deleteIssueTypeScheme<T = void>(
parameters: Version3Parameters.DeleteIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Deletes an issue type scheme.

Only issue type schemes used in classic projects can be deleted.

Any projects assigned to the scheme are reassigned to the default issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:270
deleteIssueTypeScheme<T = void>(
parameters: Version3Parameters.DeleteIssueTypeScheme,
callback?: undefined,
): Promise<T>
Deletes an issue type scheme.

Only issue type schemes used in classic projects can be deleted.

Any projects assigned to the scheme are reassigned to the default issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:284

getAllIssueTypeSchemes

getAllIssueTypeSchemes<T = Version3Models.PageIssueTypeScheme>(
parameters: undefined | Version3Parameters.GetAllIssueTypeSchemes,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of issue type schemes.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeScheme
Parameters
- parameters: undefined | Version3Parameters.GetAllIssueTypeSchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:19
getAllIssueTypeSchemes<T = Version3Models.PageIssueTypeScheme>(
parameters?: Version3Parameters.GetAllIssueTypeSchemes,
callback?: undefined,
): Promise<T>
Returns a paginated list of issue type schemes.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeScheme
Parameters
- Optionalparameters: Version3Parameters.GetAllIssueTypeSchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:32

getIssueTypeSchemeForProjects

getIssueTypeSchemeForProjects<T = Version3Models.PageIssueTypeSchemeProjects>(
parameters: Version3Parameters.GetIssueTypeSchemeForProjects,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeSchemeProjects
Parameters
- parameters: Version3Parameters.GetIssueTypeSchemeForProjects
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:146
getIssueTypeSchemeForProjects<T = Version3Models.PageIssueTypeSchemeProjects>(
parameters: Version3Parameters.GetIssueTypeSchemeForProjects,
callback?: undefined,
): Promise<T>
Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeSchemeProjects
Parameters
- parameters: Version3Parameters.GetIssueTypeSchemeForProjects
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:159

getIssueTypeSchemesMapping

getIssueTypeSchemesMapping<T = Version3Models.PageIssueTypeSchemeMapping>(
parameters: undefined | Version3Parameters.GetIssueTypeSchemesMapping,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of issue type scheme items.

Only issue type scheme items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeSchemeMapping
Parameters
- parameters: undefined | Version3Parameters.GetIssueTypeSchemesMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:103
getIssueTypeSchemesMapping<T = Version3Models.PageIssueTypeSchemeMapping>(
parameters?: Version3Parameters.GetIssueTypeSchemesMapping,
callback?: undefined,
): Promise<T>
Returns a paginated list of issue type scheme items.

Only issue type scheme items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageIssueTypeSchemeMapping
Parameters
- Optionalparameters: Version3Parameters.GetIssueTypeSchemesMapping
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:116

removeIssueTypeFromIssueTypeScheme

removeIssueTypeFromIssueTypeScheme<T = void>(
parameters: Version3Parameters.RemoveIssueTypeFromIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Removes an issue type from an issue type scheme.

This operation cannot remove:
- Any issue type used by issues.
- Any issue types from the default issue type scheme.
- The last standard issue type from an issue type scheme.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveIssueTypeFromIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:401
removeIssueTypeFromIssueTypeScheme<T = void>(
parameters: Version3Parameters.RemoveIssueTypeFromIssueTypeScheme,
callback?: undefined,
): Promise<T>
Removes an issue type from an issue type scheme.

This operation cannot remove:
- Any issue type used by issues.
- Any issue types from the default issue type scheme.
- The last standard issue type from an issue type scheme.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveIssueTypeFromIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:417

reorderIssueTypesInIssueTypeScheme

reorderIssueTypesInIssueTypeScheme<T = void>(
parameters: Version3Parameters.ReorderIssueTypesInIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Changes the order of issue types in an issue type scheme.

The request body parameters must meet the following requirements:
- All of the issue types must belong to the issue type scheme.
- Either after or position must be provided.
- The issue type in after must not be in the issue type list.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ReorderIssueTypesInIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:352
reorderIssueTypesInIssueTypeScheme<T = void>(
parameters: Version3Parameters.ReorderIssueTypesInIssueTypeScheme,
callback?: undefined,
): Promise<T>
Changes the order of issue types in an issue type scheme.

The request body parameters must meet the following requirements:
- All of the issue types must belong to the issue type scheme.
- Either after or position must be provided.
- The issue type in after must not be in the issue type list.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ReorderIssueTypesInIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:368

updateIssueTypeScheme

updateIssueTypeScheme<T = void>(
parameters: Version3Parameters.UpdateIssueTypeScheme,
callback: Callback<T>,
): Promise<void>
Updates an issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateIssueTypeScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypeSchemes.ts:232
updateIssueTypeScheme<T = void>(
parameters: Version3Parameters.UpdateIssueTypeScheme,
callback?: undefined,
): Promise<T>
Updates an issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateIssueTypeScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypeSchemes.ts:242

Class IssueTypeSchemes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueTypeSchemes

Methods

addIssueTypesToIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

assignIssueTypeSchemeToProject

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllIssueTypeSchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueTypeSchemeForProjects

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueTypeSchemesMapping

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeIssueTypeFromIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

reorderIssueTypesInIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateIssueTypeScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings