Class IssueCustomFieldConfigurationApps

Index

Constructors

constructor

Methods

getCustomFieldConfiguration getCustomFieldsConfigurations updateCustomFieldConfiguration

Constructors

constructor

new IssueCustomFieldConfigurationApps(
client: Client,
): Version3.IssueCustomFieldConfigurationApps
Parameters
- client: Client
Returns Version3.IssueCustomFieldConfigurationApps
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:9

Methods

getCustomFieldConfiguration

getCustomFieldConfiguration<T = Version3Models.PageContextualConfiguration>(
parameters: string | Version3Parameters.GetCustomFieldConfiguration,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of configurations for a custom field of a type created by a Forge app.

The result can be filtered by one of these criteria:
- id.
- fieldContextId.
- issueId.
- projectKeyOrId and issueTypeId.
Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.
Type Parameters
- T = Version3Models.PageContextualConfiguration
Parameters
- parameters: string | Version3Parameters.GetCustomFieldConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:100
getCustomFieldConfiguration<T = Version3Models.PageContextualConfiguration>(
parameters: string | Version3Parameters.GetCustomFieldConfiguration,
callback?: undefined,
): Promise<T>
Returns a paginated list of configurations for a custom field of a type created by a Forge app.

The result can be filtered by one of these criteria:
- id.
- fieldContextId.
- issueId.
- projectKeyOrId and issueTypeId.
Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.
Type Parameters
- T = Version3Models.PageContextualConfiguration
Parameters
- parameters: string | Version3Parameters.GetCustomFieldConfiguration
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:123

getCustomFieldsConfigurations

getCustomFieldsConfigurations<
    T = Version3Models.PageBulkContextualConfiguration,
>(
    parameters: undefined | Version3Parameters.GetCustomFieldsConfigurations,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.

The result can be filtered by one of these criteria:
- id.
- fieldContextId.
- issueId.
- projectKeyOrId and issueTypeId.
Otherwise, all configurations for the provided list of custom fields are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.
Type Parameters
- T = Version3Models.PageBulkContextualConfiguration
Parameters
- parameters: undefined | Version3Parameters.GetCustomFieldsConfigurations
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:30
getCustomFieldsConfigurations<
    T = Version3Models.PageBulkContextualConfiguration,
>(
    parameters?: Version3Parameters.GetCustomFieldsConfigurations,
    callback?: undefined,
): Promise<T>
Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.

The result can be filtered by one of these criteria:
- id.
- fieldContextId.
- issueId.
- projectKeyOrId and issueTypeId.
Otherwise, all configurations for the provided list of custom fields are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.
Type Parameters
- T = Version3Models.PageBulkContextualConfiguration
Parameters
- Optionalparameters: Version3Parameters.GetCustomFieldsConfigurations
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:53

updateCustomFieldConfiguration

updateCustomFieldConfiguration<T = unknown>(
parameters: Version3Parameters.UpdateCustomFieldConfiguration,
callback: Callback<T>,
): Promise<void>
Update the configuration for contexts of a custom field of a type created by a Forge app.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field type.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.UpdateCustomFieldConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:159
updateCustomFieldConfiguration<T = unknown>(
parameters: Version3Parameters.UpdateCustomFieldConfiguration,
callback?: undefined,
): Promise<T>
Update the configuration for contexts of a custom field of a type created by a Forge app.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field type.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.UpdateCustomFieldConfiguration
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCustomFieldConfigurationApps.ts:172

Class IssueCustomFieldConfigurationApps

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueCustomFieldConfigurationApps

Methods

getCustomFieldConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCustomFieldsConfigurations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateCustomFieldConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page