Jira.js - Jira Cloud API library
    Preparing search index...

    Interface SubmitDeployments

    The result of a successful submitDeployments request.*

    interface SubmitDeployments {
        acceptedDeployments?: {
            deploymentSequenceNumber: number;
            environmentId: string;
            pipelineId: string;
        }[];
        rejectedDeployments?: {
            errors: { errorTraceId?: string; message: string }[];
            key: {
                deploymentSequenceNumber: number;
                environmentId: string;
                pipelineId: string;
            };
        }[];
        unknownAssociations?: {}[];
        unknownIssueKeys?: string[];
    }
    Index

    Properties

    acceptedDeployments? rejectedDeployments? unknownAssociations? unknownIssueKeys?

    Properties

    acceptedDeployments?: {
        deploymentSequenceNumber: number;
        environmentId: string;
        pipelineId: string;
    }[]

    The keys of deployments that have been accepted for submission. A deployment key is a composite key that consists of pipelineId, environmentId and deploymentSequenceNumber.

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

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

    Type declaration

    • deploymentSequenceNumber: number

      This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.

    • environmentId: string

      The identifier of an environment, must be unique for the provider so that it can be shared across pipelines.

    • pipelineId: string

      The identifier of a pipeline, must be unique for the provider.

    rejectedDeployments?: {
        errors: { errorTraceId?: string; message: string }[];
        key: {
            deploymentSequenceNumber: number;
            environmentId: string;
            pipelineId: string;
        };
    }[]

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

    The object will contain the deployment key and any errors associated with that deployment that have prevented it being submitted.

    Type declaration

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

      The error messages for the rejected deployment

    • key: { deploymentSequenceNumber: number; environmentId: string; pipelineId: string }

      Fields that uniquely reference a deployment.

      • deploymentSequenceNumber: number

        This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.

      • environmentId: string

        The identifier of an environment, must be unique for the provider so that it can be shared across pipelines.

      • pipelineId: string

        The identifier of a pipeline, must be unique for the provider.

    unknownAssociations?: {}[]

    Associations (e.g. Issue Keys or Service IDs) 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 deployment has been associated with any other association other than those in this array it will still be stored against those valid associations. If a deployment was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.

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

    Settings

    Member Visibility

    On This Page

    Properties