Interface SubmitDeploymentRequest

SubmitDeploymentRequest

The payload used to submit (update / insert) deployment data.

interface SubmitDeploymentRequest {
    deployments: unknown[];
    properties?: {
        [key: string]: string;
    };
    providerMetadata?: {
        product?: string;
    } & {
        [key: string]: unknown;
    };
}

Hierarchy

  • Record<string, unknown>
    • SubmitDeploymentRequest

Properties

deployments properties? providerMetadata?

Properties

deployments

deployments: unknown[]

A list of deployments to submit to Jira.

Each deployment may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.

Optionalproperties

properties?: {
    [key: string]: string;
}

Properties

Properties assigned to deployment data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.

Example

{
  "accountId": "account-234",
  "projectId": "project-123"
}

OptionalproviderMetadata

providerMetadata?: {
    product?: string;
} & {
    [key: string]: unknown;
}

ProviderMetadata

Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

Type declaration

  • Optionalproduct?: string

    An optional name of the source of the deployments data.

    Example

    Bamboo 6.10.2

Settings

Member Visibility

On This Page

Properties