Function getBuildByKey

getBuildByKey(
    client: Client,
    parameters: { buildNumber: number; pipelineId: string },
    options?: RequestOptions,
): Promise<
    {
        associations?: {
            associationType: string & {}
            | "issueKeys"
            | "issueIdOrKeys";
            values: string[];
            [key: string]: unknown;
        }[];
        buildNumber: number;
        description?: string;
        displayName: string;
        label?: string;
        lastUpdated: Date;
        pipelineId: string;
        references?: {
            commit?: { id: string; repositoryUri: string; [key: string]: unknown };
            ref?: { name: string; uri: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        schemaVersion?: string & {}
        | "1.0";
        state:
            | "failed"
            | "unknown"
            | "pending"
            | string & {}
            | "successful"
            | "in_progress"
            | "cancelled";
        testInfo?: {
            numberFailed: number;
            numberPassed: number;
            numberSkipped?: number;
            totalNumber: number;
            [key: string]: unknown;
        };
        updateSequenceNumber: number;
        url: string;
        [key: string]: unknown;
    },
>
Retrieve the currently stored build data for the given pipelineId and buildNumber combination.

The result will be what is currently stored, ignoring any pending updates or deletes.
Parameters
- client: Client
- parameters: { buildNumber: number; pipelineId: string }
  - buildNumber: number
    
    The buildNumber of the build.
  - pipelineId: string
    
    The pipelineId of the build.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        associations?: {
            associationType: string & {}
            | "issueKeys"
            | "issueIdOrKeys";
            values: string[];
            [key: string]: unknown;
        }[];
        buildNumber: number;
        description?: string;
        displayName: string;
        label?: string;
        lastUpdated: Date;
        pipelineId: string;
        references?: {
            commit?: { id: string; repositoryUri: string; [key: string]: unknown };
            ref?: { name: string; uri: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        schemaVersion?: string & {}
        | "1.0";
        state:
            | "failed"
            | "unknown"
            | "pending"
            | string & {}
            | "successful"
            | "in_progress"
            | "cancelled";
        testInfo?: {
            numberFailed: number;
            numberPassed: number;
            numberSkipped?: number;
            totalNumber: number;
            [key: string]: unknown;
        };
        updateSequenceNumber: number;
        url: string;
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/builds.ts:80

Function getBuildByKey

Parameters

buildNumber: number

pipelineId: string

Settings