Interface SubmitFeatureFlags

The result of a successful submitFeatureFlags request.*

interface SubmitFeatureFlags {
    acceptedFeatureFlags?: string[];
    failedFeatureFlags?: {};
    unknownIssueKeys?: string[];
}

Properties

acceptedFeatureFlags? failedFeatureFlags? unknownIssueKeys?

Properties

Optional acceptedFeatureFlags

acceptedFeatureFlags?: string[]

The IDs of Feature Flags that have been accepted for submission.

A Feature Flag may be rejected if it was only associated with unknown issue keys.

Note that a Feature Flag that isn't updated due to it's updateSequenceId being out of order is not considered a failed submission.

Optional failedFeatureFlags

failedFeatureFlags?: {}

Details of Feature Flags that have not been accepted for submission, usually due to a problem with the request data.

The object (if present) will be keyed by Feature Flag ID and include any errors associated with that Feature Flag that have prevented it being submitted.

Type declaration

    Optional unknownIssueKeys

    unknownIssueKeys?: string[]

    Issue keys that are not known on this Jira instance (if any).

    These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.

    If a Feature Flag has been associated with issue keys other than those in this array it will still be stored against those valid keys. If a Feature Flag was only associated with issue keys deemed to be invalid it won't be persisted.

    Settings

    Member Visibility

    Theme

    On This Page

    acceptedFeatureFlagsfailedFeatureFlagsunknownIssueKeys