Class IssueFieldConfigurations

Index

Constructors

Methods

assignFieldConfigurationSchemeToProject createFieldConfiguration createFieldConfigurationScheme deleteFieldConfiguration deleteFieldConfigurationScheme getAllFieldConfigurations getAllFieldConfigurationSchemes getFieldConfigurationItems getFieldConfigurationSchemeMappings getFieldConfigurationSchemeProjectMapping removeIssueTypesFromGlobalFieldConfigurationScheme setFieldConfigurationSchemeMapping updateFieldConfiguration updateFieldConfigurationItems updateFieldConfigurationScheme

Constructors

constructor

new IssueFieldConfigurations(client: Client): Version3.IssueFieldConfigurations
Parameters
- client: Client
Returns Version3.IssueFieldConfigurations
- Defined in src/version3/issueFieldConfigurations.ts:9

Methods

assignFieldConfigurationSchemeToProject

assignFieldConfigurationSchemeToProject<T = void>(
    parameters:
        | Version3Parameters.AssignFieldConfigurationSchemeToProject
        | undefined,
    callback: Callback<T>,
): Promise<void>
Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.

Field configuration schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AssignFieldConfigurationSchemeToProject | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:465
assignFieldConfigurationSchemeToProject<T = void>(
parameters?: Version3Parameters.AssignFieldConfigurationSchemeToProject,
callback?: undefined,
): Promise<T>
Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.

Field configuration schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalparameters: Version3Parameters.AssignFieldConfigurationSchemeToProject
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:478

createFieldConfiguration

createFieldConfiguration<T = Version3Models.FieldConfiguration>(
parameters: Version3Parameters.CreateFieldConfiguration,
callback: Callback<T>,
): Promise<void>
Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

This operation can only create configurations for use in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldConfiguration
Parameters
- parameters: Version3Parameters.CreateFieldConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:75
createFieldConfiguration<T = Version3Models.FieldConfiguration>(
parameters: Version3Parameters.CreateFieldConfiguration,
callback?: undefined,
): Promise<T>
Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

This operation can only create configurations for use in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldConfiguration
Parameters
- parameters: Version3Parameters.CreateFieldConfiguration
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:88

createFieldConfigurationScheme

createFieldConfigurationScheme<T = Version3Models.FieldConfigurationScheme>(
parameters: Version3Parameters.CreateFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>
Creates a field configuration scheme.

This operation can only create field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldConfigurationScheme
Parameters
- parameters: Version3Parameters.CreateFieldConfigurationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:332
createFieldConfigurationScheme<T = Version3Models.FieldConfigurationScheme>(
parameters: Version3Parameters.CreateFieldConfigurationScheme,
callback?: undefined,
): Promise<T>
Creates a field configuration scheme.

This operation can only create field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.FieldConfigurationScheme
Parameters
- parameters: Version3Parameters.CreateFieldConfigurationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:344

deleteFieldConfiguration

deleteFieldConfiguration<T = void>(
parameters: Version3Parameters.DeleteFieldConfiguration,
callback: Callback<T>,
): Promise<void>
Deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteFieldConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:156
deleteFieldConfiguration<T = void>(
parameters: Version3Parameters.DeleteFieldConfiguration,
callback?: undefined,
): Promise<T>
Deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

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

deleteFieldConfigurationScheme

deleteFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.DeleteFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>
Deletes a field configuration scheme.

This operation can only delete field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteFieldConfigurationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:546
deleteFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.DeleteFieldConfigurationScheme,
callback?: undefined,
): Promise<T>
Deletes a field configuration scheme.

This operation can only delete field configuration schemes used in company-managed (classic) projects.

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

getAllFieldConfigurations

getAllFieldConfigurations<
    T = Paginated<Version3Models.FieldConfigurationDetails>,
>(
    parameters: Version3Parameters.GetAllFieldConfigurations | undefined,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
- A list of field configuration item IDs.
- Whether the field configuration is a default.
- Whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Paginated<Version3Models.FieldConfigurationDetails>
Parameters
- parameters: Version3Parameters.GetAllFieldConfigurations | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:25
getAllFieldConfigurations<
    T = Paginated<Version3Models.FieldConfigurationDetails>,
>(
    parameters?: Version3Parameters.GetAllFieldConfigurations,
    callback?: undefined,
): Promise<T>
Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
- A list of field configuration item IDs.
- Whether the field configuration is a default.
- Whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Paginated<Version3Models.FieldConfigurationDetails>
Parameters
- Optionalparameters: Version3Parameters.GetAllFieldConfigurations
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:43

getAllFieldConfigurationSchemes

getAllFieldConfigurationSchemes<T = Version3Models.PageFieldConfigurationScheme>(
    parameters:
        | Version3Parameters.GetAllFieldConfigurationSchemes
        | undefined,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of field configuration schemes.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationScheme
Parameters
- parameters: Version3Parameters.GetAllFieldConfigurationSchemes | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:290
getAllFieldConfigurationSchemes<T = Version3Models.PageFieldConfigurationScheme>(
parameters?: Version3Parameters.GetAllFieldConfigurationSchemes,
callback?: undefined,
): Promise<T>
Returns a paginated list of field configuration schemes.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationScheme
Parameters
- Optionalparameters: Version3Parameters.GetAllFieldConfigurationSchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:303

getFieldConfigurationItems

getFieldConfigurationItems<T = Version3Models.PageFieldConfigurationItem>(
parameters: Version3Parameters.GetFieldConfigurationItems,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of all fields for a configuration.

Only the fields from configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationItem
Parameters
- parameters: Version3Parameters.GetFieldConfigurationItems
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:193
getFieldConfigurationItems<T = Version3Models.PageFieldConfigurationItem>(
parameters: Version3Parameters.GetFieldConfigurationItems,
callback?: undefined,
): Promise<T>
Returns a paginated list of all fields for a configuration.

Only the fields from configurations used in company-managed (classic) projects are returned.

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

getFieldConfigurationSchemeMappings

getFieldConfigurationSchemeMappings<
    T = Version3Models.PageFieldConfigurationIssueTypeItem,
>(
    parameters:
        | Version3Parameters.GetFieldConfigurationSchemeMappings
        | undefined,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of field configuration issue type items.

Only items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationIssueTypeItem
Parameters
- parameters: Version3Parameters.GetFieldConfigurationSchemeMappings | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:373
getFieldConfigurationSchemeMappings<
    T = Version3Models.PageFieldConfigurationIssueTypeItem,
>(
    parameters?: Version3Parameters.GetFieldConfigurationSchemeMappings,
    callback?: undefined,
): Promise<T>
Returns a paginated list of field configuration issue type items.

Only items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationIssueTypeItem
Parameters
- Optionalparameters: Version3Parameters.GetFieldConfigurationSchemeMappings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:386

getFieldConfigurationSchemeProjectMapping

getFieldConfigurationSchemeProjectMapping<
    T = Version3Models.PageFieldConfigurationSchemeProjects,
>(
    parameters: Version3Parameters.GetFieldConfigurationSchemeProjectMapping,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationSchemeProjects
Parameters
- parameters: Version3Parameters.GetFieldConfigurationSchemeProjectMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:419
getFieldConfigurationSchemeProjectMapping<
    T = Version3Models.PageFieldConfigurationSchemeProjects,
>(
    parameters: Version3Parameters.GetFieldConfigurationSchemeProjectMapping,
    callback?: undefined,
): Promise<T>
Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageFieldConfigurationSchemeProjects
Parameters
- parameters: Version3Parameters.GetFieldConfigurationSchemeProjectMapping
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueFieldConfigurations.ts:435

removeIssueTypesFromGlobalFieldConfigurationScheme

removeIssueTypesFromGlobalFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>
Removes issue types from the field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:621
removeIssueTypesFromGlobalFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme,
callback?: undefined,
): Promise<T>
Removes issue types from the field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

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

setFieldConfigurationSchemeMapping

setFieldConfigurationSchemeMapping<T = void>(
parameters: Version3Parameters.SetFieldConfigurationSchemeMapping,
callback: Callback<T>,
): Promise<void>
Assigns issue types to field configurations on field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.SetFieldConfigurationSchemeMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:582
setFieldConfigurationSchemeMapping<T = void>(
parameters: Version3Parameters.SetFieldConfigurationSchemeMapping,
callback?: undefined,
): Promise<T>
Assigns issue types to field configurations on field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

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

updateFieldConfiguration

updateFieldConfiguration<T = void>(
parameters: Version3Parameters.UpdateFieldConfiguration,
callback: Callback<T>,
): Promise<void>
Updates a field configuration. The name and the description provided in the request override the existing values.

This operation can only update configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateFieldConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:116
updateFieldConfiguration<T = void>(
parameters: Version3Parameters.UpdateFieldConfiguration,
callback?: undefined,
): Promise<T>
Updates a field configuration. The name and the description provided in the request override the existing values.

This operation can only update configurations used in company-managed (classic) projects.

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

updateFieldConfigurationItems

updateFieldConfigurationItems<T = void>(
parameters: Version3Parameters.UpdateFieldConfigurationItems,
callback: Callback<T>,
): Promise<void>
Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

This operation can only update field configurations used in company-managed (classic) projects.

The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

Hiding a field deletes it from the field configuration - deleting the required, description and renderer type values as well. As a result, hiding and unhiding will not restore the other values but use their default values.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateFieldConfigurationItems
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:242
updateFieldConfigurationItems<T = void>(
parameters: Version3Parameters.UpdateFieldConfigurationItems,
callback?: undefined,
): Promise<T>
Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

This operation can only update field configurations used in company-managed (classic) projects.

The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

Hiding a field deletes it from the field configuration - deleting the required, description and renderer type values as well. As a result, hiding and unhiding will not restore the other values but use their default values.

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

updateFieldConfigurationScheme

updateFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.UpdateFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>
Updates a field configuration scheme.

This operation can only update field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateFieldConfigurationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueFieldConfigurations.ts:506
updateFieldConfigurationScheme<T = void>(
parameters: Version3Parameters.UpdateFieldConfigurationScheme,
callback?: undefined,
): Promise<T>
Updates a field configuration scheme.

This operation can only update field configuration schemes used in company-managed (classic) projects.

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

Class IssueFieldConfigurations

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueFieldConfigurations

Methods

assignFieldConfigurationSchemeToProject

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createFieldConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createFieldConfigurationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteFieldConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteFieldConfigurationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllFieldConfigurations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllFieldConfigurationSchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFieldConfigurationItems

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFieldConfigurationSchemeMappings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFieldConfigurationSchemeProjectMapping

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeIssueTypesFromGlobalFieldConfigurationScheme