jira.js
    Preparing search index...

    Function deleteComponentsByProperty

    • Bulk delete all Components that match the given request.

      One or more query params must be supplied to specify Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND). See the documentation for the submitComponents operation for more details.

      E.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

      Deletion is performed asynchronously. The getComponentById operation can be used to confirm that data has been deleted successfully (if needed).

      Only Connect apps that define the jiraDevOpsComponentProvider module can access this resource. This resource requires the 'DELETE' scope for Connect apps.

      Parameters

      • client: Client
      • parameters: { accountId: string; createdBy?: string }
        • accountId: string

          Property key used to select which submitted DevOps components to delete. Must match a key previously sent in submitComponents properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.

        • OptionalcreatedBy?: string

          Optional additional property filter combined with accountId (AND). Must match a key previously supplied in submitComponents properties. Example: createdBy=user-456.

      • Optionaloptions: RequestOptions

      Returns Promise<void>

    Settings
    Member Visibility