OpenAPI を使用してオートメーションを削除する

DELETE /api/v1/openapi/automations/{id} エンドポイントを呼び出して、Automation Hub からオートメーションを削除します。

前提条件

• アクティブな Automation Hub API トークンを持っている。手順については、「 Automation Hub からトークンを生成する」をご覧ください。
• 削除するオートメーションの数値 ID がわかっている。データは、Automation Hub 内のオートメーションの URL から、または GET /api/v1/openapi/automations 呼び出しを介して取得できます。
• システム管理者またはプログラム マネージャーのロールを持っている。

オートメーションを削除する

1. オートメーション ID を使用して要求 URL を作成します。

   DELETE https://{baseUrl}/api/v1/openapi/automations/{id}
   

2. 必要な認証ヘッダーを含めます。

   ヘッダー	値 (Value)
   x-ah-openapi-app-key	Automation Hub API トークン
   x-ah-openapi-auth	openapi
   Content-Type	application/json

3. 必要に応じて、要求本文にコメントを含めます。

   {
     "comment": "Removing duplicate entry."
   }
   

4. 要求を送信します。

結果

削除が成功すると、HTTP 200が返されます。オートメーションがテナントから完全に削除され、Automation Hub に表示されなくなります。

エラー コード

コード	意味
400	不正な要求 — 要求本文の形式が正しくないか、必須フィールドが無効です。
404	見つからない — 指定した ID のオートメーションがテナントに存在しません。

例: スクリプトを使用して複数のオートメーションを削除する

オートメーションのリストを ID で削除するには、次の PowerShell スクリプトを使用します。

$baseUrl  = "https://<your-tenant>.automation-hub.uipath.com"
$appKey   = "<your-api-token>"
$ids      = @(1001, 1002, 1003)
$comment  = "Bulk cleanup"

foreach ($id in $ids) {
    $response = Invoke-RestMethod `
        -Method Delete `
        -Uri "$baseUrl/api/v1/openapi/automations/$id" `
        -Headers @{
            "x-ah-openapi-app-key" = $appKey
            "x-ah-openapi-auth"    = "openapi"
            "Content-Type"         = "application/json"
        } `
        -Body (ConvertTo-Json @{ comment = $comment })
    Write-Host "Deleted $id — Status: $($response.StatusCode)"
}

詳しくは、「 API リファレンス」 をご覧ください。