Interface SubmitBuildsResponse

SubmitBuildsResponse

The result of a successful submitBuilds request.

interface SubmitBuildsResponse {
    acceptedBuilds?: BuildKey[];
    rejectedBuilds?: RejectedBuild[];
    unknownIssueKeys?: string[];
}

Hierarchy

  • Record<string, unknown>
    • SubmitBuildsResponse

Properties

acceptedBuilds? rejectedBuilds? unknownIssueKeys?

Properties

OptionalacceptedBuilds

acceptedBuilds?: BuildKey[]

The keys of builds that have been accepted for submission. A build key is a composite key that consists of pipelineId and buildNumber.

A build may be rejected if it was only associated with unknown issue keys, or if the submitted data for that build does not match the required schema.

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

OptionalrejectedBuilds

rejectedBuilds?: RejectedBuild[]

Details of builds that have not been accepted for submission.

A build may be rejected if it was only associated with unknown issue keys, or if the submitted data for the build does not match the required schema.

OptionalunknownIssueKeys

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 build has been associated with issue keys other than those in this array it will still be stored against those valid keys. If a build was only associated with issue keys deemed to be invalid it won't be persisted.

Settings

Member Visibility

On This Page

Properties