Class FeatureFlagsService

Apis related to integrating Feature Flags with Jira Software. These apis are only available to Atlassian Connect apps. To use these apis you must have the Feature Flag module (see https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in your app's descriptor

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags

Hierarchy

  • CommonHttpService
    • FeatureFlagsService

Constructors

constructor

Methods

deleteFeatureFlagById deleteFeatureFlagsByProperty getFeatureFlagById submitFeatureFlags initialize

Constructors

constructor

  • new FeatureFlagsService(getClientInstance): FeatureFlagsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns FeatureFlagsService

Methods

deleteFeatureFlagById

  • deleteFeatureFlagById(params): Promise<void>

  • Delete the Feature Flag data currently stored for the given ID.

    Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          featureFlagId: string;
          updateSequenceId?: number;
      }
      • authorization: string

        All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.

        If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.

      • featureFlagId: string

        The ID of the Feature Flag to delete.

      • OptionalupdateSequenceId?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceId to use to control deletion.

        Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/featureflags/0.1/flag/{featureFlagId}

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-flag-featureflagid-delete

deleteFeatureFlagsByProperty

  • deleteFeatureFlagsByProperty(params): Promise<void>

  • Bulk delete all Feature Flags that match the given request.

    One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceId is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND). See the documentation for the submitFeatureFlags operation for more details.

    e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

    Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          updateSequenceId?: number;
      }
      • authorization: string

        All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.

        If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.

      • OptionalupdateSequenceId?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceId to use to control deletion.

        Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        If not provided, all stored data that matches the request will be deleted.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/featureflags/0.1/bulkByProperties

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-bulkbyproperties-delete

getFeatureFlagById

submitFeatureFlags

  • submitFeatureFlags(params): Promise<SubmitFeatureFlagsResponse>

  • Update / insert Feature Flag data.

    Feature Flags are identified by their ID, and existing Feature Flag data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.

    Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getFeatureFlagById operation can be used to confirm that data has been stored successfully (if needed).

    In the case of multiple Feature Flags being submitted in one request, each is validated individually prior to submission. Details of which Feature Flags failed submission (if any) are available in the response object.

    Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource. This resource requires the 'WRITE' scope for Connect apps.

    Parameters

    Returns Promise<SubmitFeatureFlagsResponse>

    Submission accepted. Each submitted Feature Flag that is of a valid format will be eventually available in Jira.

    Details of which Feature Flags were submitted and which failed submission (due to data format problems etc.) are available in the response object.

    Path

    POST /rest/featureflags/0.1/bulk

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-bulk-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