Interface SubmitBuilds

The result of a successful submitBuilds request.*

interface SubmitBuilds {
    acceptedBuilds?: {
        buildNumber: number;
        pipelineId: string;
    }[];
    rejectedBuilds?: {
        errors: {
            errorTraceId?: string;
            message: string;
        }[];
        key: {
            buildNumber: number;
            pipelineId: string;
        };
    }[];
    unknownIssueKeys?: string[];
}

Properties

acceptedBuilds? rejectedBuilds? unknownIssueKeys?

Properties

Optional acceptedBuilds

acceptedBuilds?: {
    buildNumber: number;
    pipelineId: string;
}[]

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.

Type declaration

  • buildNumber: number

    Identifies a build within the sequence of builds identified by the build pipelineId.

    Used to identify the 'most recent' build in that sequence of builds.

    The combination of pipelineId and buildNumber must uniquely identify the build.

  • pipelineId: string

    An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID, plan key etc. - whatever logical unit you use to group a sequence of builds.

    The combination of pipelineId and buildNumber must uniquely identify the build.

Optional rejectedBuilds

rejectedBuilds?: {
    errors: {
        errorTraceId?: string;
        message: string;
    }[];
    key: {
        buildNumber: number;
        pipelineId: string;
    };
}[]

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.

Type declaration

  • errors: {
        errorTraceId?: string;
        message: string;
    }[]

    The error messages for the rejected build

  • key: {
        buildNumber: number;
        pipelineId: string;
    }

    Fields that uniquely reference a build.

    • buildNumber: number

      Identifies a build within the sequence of builds identified by the build pipelineId.

      Used to identify the 'most recent' build in that sequence of builds.

      The combination of pipelineId and buildNumber must uniquely identify the build.

    • pipelineId: string

      An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID, plan key etc. - whatever logical unit you use to group a sequence of builds.

      The combination of pipelineId and buildNumber must uniquely identify the build.

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

Theme

On This Page

acceptedBuildsrejectedBuildsunknownIssueKeys