Class IssueCustomFieldValuesAppsService

This resource represents the values of custom fields added by Forge apps. Use it to update the value of a custom field on issues.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-

Hierarchy

CommonHttpService
- IssueCustomFieldValuesAppsService

Index

Constructors

Methods

updateCustomFieldValue updateMultipleCustomFieldValues initialize

Constructors

constructor

new IssueCustomFieldValuesAppsService(getClientInstance): IssueCustomFieldValuesAppsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueCustomFieldValuesAppsService
Inherited from CommonHttpService.constructor

Methods

updateCustomFieldValue

updateCustomFieldValue(params): Promise<void>
Updates the value of a custom field on one or more issues.

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
Parameters
- params: {
      customFieldValueUpdateDetails: CustomFieldValueUpdateDetails;
      fieldIdOrKey: string;
      generateChangelog?: boolean;
  }
  - customFieldValueUpdateDetails: CustomFieldValueUpdateDetails
    Example
  - fieldIdOrKey: string
    The ID or key of the custom field. For example, customfield_10010.
  - OptionalgenerateChangelog?: boolean
    Whether to generate a changelog for this update.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/app/field/{fieldIdOrKey}/value @scopes-current @scopes-beta write:app-data:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-#api-rest-api-3-app-field-fieldidorkey-value-put

updateMultipleCustomFieldValues

updateMultipleCustomFieldValues(params): Promise<void>
Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request.

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
Parameters
- params: {
  generateChangelog?: boolean;
  multipleCustomFieldValuesUpdateDetails: MultipleCustomFieldValuesUpdateDetails;
  }
  - OptionalgenerateChangelog?: boolean
    Whether to generate a changelog for this update.
  - multipleCustomFieldValuesUpdateDetails: MultipleCustomFieldValuesUpdateDetails
    Example
Returns Promise<void>
Returned if the request is successful.

Path
POST /rest/api/3/app/field/value @scopes-current @scopes-beta write:app-data:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-#api-rest-api-3-app-field-value-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize