Function submitComponents

submitComponents(
    client: Client,
    parameters: {
        devopsComponents: {
            avatarUrl: string;
            componentType:
                | string & {}
                | "Service"
                | "Application"
                | "Library"
                | "Capability"
                | "Cloud resource"
                | "Data pipeline"
                | "Machine learning model"
                | "UI element"
                | "Website"
                | "Other";
            description: string;
            id: string;
            lastUpdated: string
            | Date;
            name: string;
            providerName?: string;
            schemaVersion: string & {} | "1.0";
            tier: string & {} | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4";
            updateSequenceNumber: number;
            url: string;
        }[];
        properties?: Record<string, any>;
        providerMetadata?: { product?: string };
    },
    options?: RequestOptions,
): Promise<
    {
        acceptedComponents?: string[];
        failedComponents?: Record<string, any>;
        unknownProjectKeys?: string[];
        [key: string]: unknown;
    },
>
Update / insert DevOps Component data.

Components are identified by their ID, and existing Component data for the same ID will be replaced if it exists and the updateSequenceNumber of existing data is less than the incoming data.

Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getComponentById operation can be used to confirm that data has been stored successfully (if needed).

In the case of multiple Components being submitted in one request, each is validated individually prior to submission. Details of which Components failed submission (if any) are available in the response object.

A maximum of 1000 components can be submitted in one request.

Only Connect apps that define the jiraDevOpsComponentProvider module can access this resource. This resource requires the 'WRITE' scope for Connect apps.
Parameters
- client: Client
- parameters: {
      devopsComponents: {
          avatarUrl: string;
          componentType:
              | string & {}
              | "Service"
              | "Application"
              | "Library"
              | "Capability"
              | "Cloud resource"
              | "Data pipeline"
              | "Machine learning model"
              | "UI element"
              | "Website"
              | "Other";
          description: string;
          id: string;
          lastUpdated: string
          | Date;
          name: string;
          providerName?: string;
          schemaVersion: string & {} | "1.0";
          tier: string & {} | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4";
          updateSequenceNumber: number;
          url: string;
      }[];
      properties?: Record<string, any>;
      providerMetadata?: { product?: string };
  }
  - devopsComponents: {
        avatarUrl: string;
        componentType:
            | string & {}
            | "Service"
            | "Application"
            | "Library"
            | "Capability"
            | "Cloud resource"
            | "Data pipeline"
            | "Machine learning model"
            | "UI element"
            | "Website"
            | "Other";
        description: string;
        id: string;
        lastUpdated: string
        | Date;
        name: string;
        providerName?: string;
        schemaVersion: string & {} | "1.0";
        tier: string & {} | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4";
        updateSequenceNumber: number;
        url: string;
    }[]
  - Optionalproperties?: Record<string, any>
    
    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 '_'.
  - OptionalproviderMetadata?: { product?: string }
    
    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.
    
    Optionalproduct?: string
    
    An optional name of the source of the incidents.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        acceptedComponents?: string[];
        failedComponents?: Record<string, any>;
        unknownProjectKeys?: string[];
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/devopsComponents.ts:27

Function submitComponents

Parameters

`Optional`properties?: Record<string, any>

`Optional`providerMetadata?: { product?: string }

`Optional`product?: string

Returns Promise<
    {
        acceptedComponents?: string[];
        failedComponents?: Record<string, any>;
        unknownProjectKeys?: string[];
        [key: string]: unknown;
    },
>

Settings

Function submitComponents

Parameters

Optionalproperties?: Record<string, any>

OptionalproviderMetadata?: { product?: string }

Optionalproduct?: string

Returns Promise< { acceptedComponents?: string[]; failedComponents?: Record<string, any>; unknownProjectKeys?: string[]; [key: string]: unknown; },>

Settings

`Optional`properties?: Record<string, any>

`Optional`providerMetadata?: { product?: string }

`Optional`product?: string

Returns Promise<
{
acceptedComponents?: string[];
failedComponents?: Record<string, any>;
unknownProjectKeys?: string[];
[key: string]: unknown;
},
>