Class IssueTypes

Index

Constructors

Methods

createIssueType createIssueTypeAvatar deleteIssueType getAlternativeIssueTypes getIssueAllTypes getIssueType getIssueTypesForProject updateIssueType

Constructors

constructor

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

Methods

createIssueType

createIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.CreateIssueType,
callback: Callback<T>,
): Promise<void>
Creates an issue type and adds it to the default issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.CreateIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:53
createIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.CreateIssueType,
callback?: undefined,
): Promise<T>
Creates an issue type and adds it to the default issue type scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.CreateIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:63

createIssueTypeAvatar

createIssueTypeAvatar<T = Version3Models.Avatar>(
parameters: Version3Parameters.CreateIssueTypeAvatar,
callback: Callback<T>,
): Promise<void>
Loads an avatar for the issue type.

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Avatar
Parameters
- parameters: Version3Parameters.CreateIssueTypeAvatar
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:279
createIssueTypeAvatar<T = Version3Models.Avatar>(
parameters: Version3Parameters.CreateIssueTypeAvatar,
callback?: undefined,
): Promise<T>
Loads an avatar for the issue type.

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Avatar
Parameters
- parameters: Version3Parameters.CreateIssueTypeAvatar
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:298

deleteIssueType

deleteIssueType<T = void>(
parameters: Version3Parameters.DeleteIssueType,
callback: Callback<T>,
): Promise<void>
Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:206
deleteIssueType<T = void>(
parameters: Version3Parameters.DeleteIssueType,
callback?: undefined,
): Promise<T>
Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

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

getAlternativeIssueTypes

getAlternativeIssueTypes<T = Version3Models.IssueTypeDetails[]>(
parameters: Version3Parameters.GetAlternativeIssueTypes,
callback: Callback<T>,
): Promise<void>
Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- parameters: Version3Parameters.GetAlternativeIssueTypes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:236
getAlternativeIssueTypes<T = Version3Models.IssueTypeDetails[]>(
parameters: Version3Parameters.GetAlternativeIssueTypes,
callback?: undefined,
): Promise<T>
Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- parameters: Version3Parameters.GetAlternativeIssueTypes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:248

getIssueAllTypes

getIssueAllTypes<T = Version3Models.IssueTypeDetails[]>(
callback: Callback<T>,
): Promise<void>
Returns all issue types.

This operation can be accessed anonymously.

Permissions required: Issue types are only returned as follows:
- If the user has the Administer Jira global permission, all issue types are returned.
- If the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:23
getIssueAllTypes<T = Version3Models.IssueTypeDetails[]>(
callback?: undefined,
): Promise<T>
Returns all issue types.

This operation can be accessed anonymously.

Permissions required: Issue types are only returned as follows:
- If the user has the Administer Jira global permission, all issue types are returned.
- If the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:37

getIssueType

getIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.GetIssueType,
callback: Callback<T>,
): Promise<void>
Returns an issue type.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.GetIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:135
getIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.GetIssueType,
callback?: undefined,
): Promise<T>
Returns an issue type.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.GetIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:148

getIssueTypesForProject

getIssueTypesForProject<T = Version3Models.IssueTypeDetails[]>(
parameters: Version3Parameters.GetIssueTypesForProject,
callback: Callback<T>,
): Promise<void>
Returns issue types for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- parameters: Version3Parameters.GetIssueTypesForProject
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:93
getIssueTypesForProject<T = Version3Models.IssueTypeDetails[]>(
parameters: Version3Parameters.GetIssueTypesForProject,
callback?: undefined,
): Promise<T>
Returns issue types for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails[]
Parameters
- parameters: Version3Parameters.GetIssueTypesForProject
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:106

updateIssueType

updateIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.UpdateIssueType,
callback: Callback<T>,
): Promise<void>
Updates the issue type.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.UpdateIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueTypes.ts:167
updateIssueType<T = Version3Models.IssueTypeDetails>(
parameters: Version3Parameters.UpdateIssueType,
callback?: undefined,
): Promise<T>
Updates the issue type.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeDetails
Parameters
- parameters: Version3Parameters.UpdateIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueTypes.ts:177

Class IssueTypes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueTypes

Methods

createIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createIssueTypeAvatar

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAlternativeIssueTypes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueAllTypes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueTypesForProject

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page