Class IssueCustomFieldConfigurationAppsService

This resource represents configurations stored against a custom field context by a Forge app. Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations.

See

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

Hierarchy

  • CommonHttpService
    • IssueCustomFieldConfigurationAppsService

Constructors

constructor

Methods

getCustomFieldConfiguration getCustomFieldsConfigurations updateCustomFieldConfiguration initialize

Constructors

constructor

Methods

getCustomFieldConfiguration

  • getCustomFieldConfiguration(params): Promise<PageBeanContextualConfiguration>

  • 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.

    Parameters

    • params: {
          fieldContextId?: number[];
          fieldIdOrKey: string;
          id?: number[];
          issueId?: number;
          issueTypeId?: string;
          maxResults?: number;
          projectKeyOrId?: string;
          startAt?: number;
      }
      • OptionalfieldContextId?: number[]

        The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.

      • fieldIdOrKey: string

        The ID or key of the custom field, for example customfield_10000.

      • Optionalid?: number[]

        The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.

      • OptionalissueId?: number

        The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.

      • OptionalissueTypeId?: string

        The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.

      • OptionalmaxResults?: number

        The maximum number of items to return per page.

      • OptionalprojectKeyOrId?: string

        The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.

      • OptionalstartAt?: number

        The index of the first item to return in a page of results (page offset).

    Returns Promise<PageBeanContextualConfiguration>

    Returned if the request is successful.

    example:

    {
      "isLast": true,
      "maxResults": 1000,
      "startAt": 0,
      "total": 2,
      "values": [
        {
          "id": "10000",
          "fieldContextId": "10010"
        },
        {
          "id": "10001",
          "fieldContextId": "10011",
          "configuration": {
            "minValue": 0,
            "maxValue": 10000
          },
          "schema": {
            "properties": {
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              }
            },
            "required": [
              "amount",
              "currency"
            ]
          }
        }
      ]
    }

    Path

    GET /rest/api/3/app/field/{fieldIdOrKey}/context/configuration @scopes-current manage:jira-configuration @scopes-beta read:custom-field-contextual-configuration:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-#api-rest-api-3-app-field-fieldidorkey-context-configuration-get

getCustomFieldsConfigurations

  • getCustomFieldsConfigurations(params): Promise<PageBeanBulkContextualConfiguration>

  • 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.

    Parameters

    • params: {
          configurationsListParameters: ConfigurationsListParameters;
          fieldContextId?: number[];
          id?: number[];
          issueId?: number;
          issueTypeId?: string;
          maxResults?: number;
          projectKeyOrId?: string;
          startAt?: number;
      }
      • configurationsListParameters: ConfigurationsListParameters

        Example

      • OptionalfieldContextId?: number[]

        The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.

      • Optionalid?: number[]

        The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.

      • OptionalissueId?: number

        The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.

      • OptionalissueTypeId?: string

        The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.

      • OptionalmaxResults?: number

        The maximum number of items to return per page.

      • OptionalprojectKeyOrId?: string

        The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.

      • OptionalstartAt?: number

        The index of the first item to return in a page of results (page offset).

    Returns Promise<PageBeanBulkContextualConfiguration>

    Returned if the request is successful.

    example:

    {
      "isLast": true,
      "maxResults": 1000,
      "startAt": 0,
      "total": 2,
      "values": [
        {
          "customFieldId": "customfield_10035",
          "fieldContextId": "10010",
          "id": "10000"
        },
        {
          "configuration": {
            "maxValue": 10000,
            "minValue": 0
          },
          "customFieldId": "customfield_10036",
          "fieldContextId": "10011",
          "id": "10001",
          "schema": {
            "properties": {
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              }
            },
            "required": [
              "amount",
              "currency"
            ]
          }
        }
      ]
    }

    Path

    POST /rest/api/3/app/field/context/configuration/list @scopes-current manage:jira-configuration @scopes-beta read:custom-field-contextual-configuration:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-#api-rest-api-3-app-field-context-configuration-list-post

updateCustomFieldConfiguration

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