Class IssueFields

Index

Constructors

Methods

createCustomField deleteCustomField getFields getFieldsPaginated getTrashedFieldsPaginated restoreCustomField trashCustomField updateCustomField

Constructors

constructor

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

Methods

createCustomField

createCustomField<T = Version3Models.FieldDetails>(
parameters: Version3Parameters.CreateCustomField,
callback: Callback<T>,
): Promise<void>
Creates a custom field.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldDetails
Parameters
- parameters: Version3Parameters.CreateCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:57
createCustomField<T = Version3Models.FieldDetails>(
parameters: Version3Parameters.CreateCustomField,
callback?: undefined,
): Promise<T>
Creates a custom field.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldDetails
Parameters
- parameters: Version3Parameters.CreateCustomField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:67

deleteCustomField

deleteCustomField<T = unknown>(
parameters: Version3Parameters.DeleteCustomField,
callback: Callback<T>,
): Promise<void>
Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:235
deleteCustomField<T = unknown>(
parameters: Version3Parameters.DeleteCustomField,
callback?: undefined,
): Promise<T>
Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteCustomField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:248

getFields

getFields<T = Version3Models.FieldDetails[]>(
callback: Callback<T>,
): Promise<void>
Returns system and custom issue fields according to the following rules:
- Fields that cannot be added to the issue navigator are always returned.
- Fields that cannot be placed on an issue screen are always returned.
- Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
- For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)
This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.FieldDetails[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:25
getFields<T = Version3Models.FieldDetails[]>(callback?: undefined): Promise<T>
Returns system and custom issue fields according to the following rules:
- Fields that cannot be added to the issue navigator are always returned.
- Fields that cannot be placed on an issue screen are always returned.
- Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
- For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)
This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.FieldDetails[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:41

getFieldsPaginated

getFieldsPaginated<T = Version3Models.PageField>(
parameters: undefined | Version3Parameters.GetFieldsPaginated,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of fields for Classic Jira projects. The list can include:
- All fields
- Specific fields, by defining id
- Fields that contain a string in the field name or description, by defining query
- Specific fields that contain a string in the field name or description, by defining id and query
Use type must be set to custom to show custom fields only.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageField
Parameters
- parameters: undefined | Version3Parameters.GetFieldsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:103
getFieldsPaginated<T = Version3Models.PageField>(
parameters?: Version3Parameters.GetFieldsPaginated,
callback?: undefined,
): Promise<T>
Returns a paginated list of fields for Classic Jira projects. The list can include:
- All fields
- Specific fields, by defining id
- Fields that contain a string in the field name or description, by defining query
- Specific fields that contain a string in the field name or description, by defining id and query
Use type must be set to custom to show custom fields only.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageField
Parameters
- Optionalparameters: Version3Parameters.GetFieldsPaginated
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:121

getTrashedFieldsPaginated

getTrashedFieldsPaginated<T = Version3Models.PageField>(
parameters: undefined | Version3Parameters.GetTrashedFieldsPaginated,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.

Only custom fields can be queried, type must be set to custom.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageField
Parameters
- parameters: undefined | Version3Parameters.GetTrashedFieldsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:155
getTrashedFieldsPaginated<T = Version3Models.PageField>(
parameters?: Version3Parameters.GetTrashedFieldsPaginated,
callback?: undefined,
): Promise<T>
Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.

Only custom fields can be queried, type must be set to custom.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageField
Parameters
- Optionalparameters: Version3Parameters.GetTrashedFieldsPaginated
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:168

restoreCustomField

restoreCustomField<T = unknown>(
parameters: Version3Parameters.RestoreCustomField,
callback: Callback<T>,
): Promise<void>
Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.RestoreCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:268
restoreCustomField<T = unknown>(
parameters: Version3Parameters.RestoreCustomField,
callback?: undefined,
): Promise<T>
Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.RestoreCustomField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:279

trashCustomField

trashCustomField<T = unknown>(
parameters: Version3Parameters.TrashCustomField,
callback: Callback<T>,
): Promise<void>
Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.TrashCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:299
trashCustomField<T = unknown>(
parameters: Version3Parameters.TrashCustomField,
callback?: undefined,
): Promise<T>
Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.TrashCustomField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFields.ts:307

updateCustomField

updateCustomField<T = void>(
parameters: Version3Parameters.UpdateCustomField,
callback: Callback<T>,
): Promise<void>
Updates a custom field.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFields.ts:198
updateCustomField<T = void>(
parameters: Version3Parameters.UpdateCustomField,
callback?: undefined,
): Promise<T>
Updates a custom field.

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

Class IssueFields

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueFields

Methods

createCustomField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteCustomField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFields

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFieldsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getTrashedFieldsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

restoreCustomField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

trashCustomField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateCustomField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page