デプロイ済みのアプリを編集する

デプロイ済みのアプリのプロパティ (タイトル、説明、バージョン、メンテナンス モードの設定など) を編集します。

API エンドポイント

PATCH <BaseURL>/models/deployed/apps/{deployedAppId}

「ルート エンドポイント パスの ベース URL 」をご覧ください。

要求ヘッダー

ヘッダー	値 (Value)
認可	Bearer <access_token>
Content-Type	application/json
X-UiPath-Internal-TenantId	<tenant_id>
X-UiPath-フォルダー キー	<folder_key>

注:

角括弧で囲まれた値 <...> をすべて、対応するユース ケース値に置き換えます。

この <access_token> は、外部アプリケーションを [ Apps ] または [ Apps.Write ] スコープと [ OR.Folders.Read ] スコープで認可したときに受け取ったものです。このアクティビティは 1 時間利用可能です。その後は新しいトークンを生成するか、更新トークンをリクエストする必要があります。

Path 変数

Path 変数	データ型	説明
deployedAppId (必須)	string	編集するアプリのデプロイ ID です。

要求本文 (必須)

{
  "version": 2,
  "title": "My Updated App",
  "description": "Updated description for the app.",
  "maintenanceModeData": {
    "isMaintenanceModeEnabled": false,
    "maintenanceModeUrl": "",
    "maintenanceExcludedUsers": []
  },
  "tags": ["tag1", "tag2"]
}

フィールド	データ型	説明
バージョン (必須)	number	デプロイ済みのアプリに設定するバージョンです。
title (必須)	string	デプロイ済みのアプリの表示タイトルです。
説明 (必須)	string	デプロイ済みのアプリの説明です。
maintenanceModeData (任意)	object	メンテナンス モードの構成。
maintenanceModeData.isMaintenanceModeEnabled	boolean	メンテナンス モードが有効かどうか。
maintenanceModeData.maintenanceModeUrl	string	メンテナンス中にユーザーをリダイレクトする URL です。
maintenanceModeData.maintenanceExcludedUsers	array	メンテナンス リダイレクトから除外されたユーザー。
tags (任意)	string[]	システム タグ値の完全なリスト。既存のすべてのタグを置き換えます。

応答

200 OK

更新したデプロイ済みのアプリの ID を返します。

{
  "id": "string"
}

401 未承認

認証されていません。Apps または Apps.Write のスコープで有効なアクセス トークンを使用していることを確認してください。

403 Forbidden

指定されたフォルダー内のデプロイ済みのアプリを編集する権限がありません。