Function getDeploymentByKey

getDeploymentByKey(
    client: Client,
    parameters: {
        deploymentSequenceNumber: number;
        environmentId: string;
        pipelineId: string;
    },
    options?: RequestOptions,
): Promise<
    {
        associations?: (
            | {
                associationType: string & {}
                | "commit"
                | "repository";
                values: (
                    | {
                        commitHash: string;
                        repositoryId: string;
                        [key: string]: unknown;
                    }
                    | { repositoryId: string; [key: string]: unknown }
                )[];
                [key: string]: unknown;
            }
            | {
                associationType: string & {}
                | "issueKeys"
                | "issueIdOrKeys";
                values: string[];
                [key: string]: unknown;
            }
            | {
                associationType: string & {}
                | "serviceIdOrKeys";
                values: string[];
                [key: string]: unknown;
            }
        )[];
        commands?: { command?: string; [key: string]: unknown }[];
        deploymentSequenceNumber: number;
        description: string;
        displayName: string;
        duration?: number;
        environment: {
            displayName: string;
            id: string;
            type:
                | "unmapped"
                | string & {}
                | "development"
                | "testing"
                | "staging"
                | "production";
            [key: string]: unknown;
        };
        label?: string;
        lastUpdated: Date;
        pipeline: {
            displayName: string;
            id: string;
            url: string;
            [key: string]: unknown;
        };
        schemaVersion?: string & {}
        | "1.0";
        state:
            | "failed"
            | "unknown"
            | "pending"
            | string & {}
            | "successful"
            | "in_progress"
            | "cancelled"
            | "rolled_back";
        updateSequenceNumber: number;
        url: string;
        [key: string]: unknown;
    },
>
Retrieve the currently stored deployment data for the given pipelineId, environmentId and deploymentSequenceNumber combination.

The result will be what is currently stored, ignoring any pending updates or deletes.
Parameters
- client: Client
- parameters: { deploymentSequenceNumber: number; environmentId: string; pipelineId: string }
  - deploymentSequenceNumber: number
    
    The deployment's deploymentSequenceNumber.
  - environmentId: string
    
    The ID of the deployment's environment.
  - pipelineId: string
    
    The ID of the deployment's pipeline.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        associations?: (
            | {
                associationType: string & {}
                | "commit"
                | "repository";
                values: (
                    | {
                        commitHash: string;
                        repositoryId: string;
                        [key: string]: unknown;
                    }
                    | { repositoryId: string; [key: string]: unknown }
                )[];
                [key: string]: unknown;
            }
            | {
                associationType: string & {}
                | "issueKeys"
                | "issueIdOrKeys";
                values: string[];
                [key: string]: unknown;
            }
            | {
                associationType: string & {}
                | "serviceIdOrKeys";
                values: string[];
                [key: string]: unknown;
            }
        )[];
        commands?: { command?: string; [key: string]: unknown }[];
        deploymentSequenceNumber: number;
        description: string;
        displayName: string;
        duration?: number;
        environment: {
            displayName: string;
            id: string;
            type:
                | "unmapped"
                | string & {}
                | "development"
                | "testing"
                | "staging"
                | "production";
            [key: string]: unknown;
        };
        label?: string;
        lastUpdated: Date;
        pipeline: {
            displayName: string;
            id: string;
            url: string;
            [key: string]: unknown;
        };
        schemaVersion?: string & {}
        | "1.0";
        state:
            | "failed"
            | "unknown"
            | "pending"
            | string & {}
            | "successful"
            | "in_progress"
            | "cancelled"
            | "rolled_back";
        updateSequenceNumber: number;
        url: string;
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/deployments.ts:85

Function getDeploymentByKey

Parameters

deploymentSequenceNumber: number

environmentId: string

pipelineId: string

Settings