Interface SubmitDevopsComponentsRequest

SubmitDevopsComponentsRequest

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

interface SubmitDevopsComponentsRequest {
    components: unknown[];
    properties?: {
        [key: string]: string;
    };
    providerMetadata?: {
        product?: string;
    };
}

Hierarchy

  • Record<string, unknown>
    • SubmitDevopsComponentsRequest

Properties

components properties? providerMetadata?

Properties

components

components: unknown[]

Optionalproperties

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

Properties

Properties assigned to incidents/components/review 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;
}

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

    Example

    Atlassian Operations Platform 2.1.0

Settings

Member Visibility

On This Page

Properties