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

Constructors

constructor

Methods

updateCustomFieldValue updateMultipleCustomFieldValues initialize

Constructors

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;
          generateAppEvents?: boolean;
          generateChangelog?: boolean;
      }
      • customFieldValueUpdateDetails: CustomFieldValueUpdateDetails

        Example

        {
        "updates": [
            {
              "issueIds": [
                10010
              ],
              "value": "new value"
            }
          ]
        }
      • fieldIdOrKey: string

        The ID or key of the custom field. For example, customfield_10010.

      • OptionalgenerateAppEvents?: boolean

        Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data.

      • 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: {
          generateAppEvents?: boolean;
          generateChangelog?: boolean;
          multipleCustomFieldValuesUpdateDetails: MultipleCustomFieldValuesUpdateDetails;
      }
      • OptionalgenerateAppEvents?: boolean

        Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data.

      • OptionalgenerateChangelog?: boolean

        Whether to generate a changelog for this update.

      • multipleCustomFieldValuesUpdateDetails: MultipleCustomFieldValuesUpdateDetails

        Example

        {
        "updates": [
            {
              "customField": "customfield_10010",
              "issueIds": [
                10010,
                10011
              ],
              "value": "new value"
            },
            {
              "customField": "customfield_10011",
              "issueIds": [
                10010
              ],
              "value": 1000
            }
          ]
        }

    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 Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods