Modifier une application déployée

Référence d'API pour modifier les propriétés d'une application déployée, telles que le titre, la description, la version et le mode de maintenance.

Modifie les propriétés d'une application déployée, telles que les paramètres de titre, de description, de version et de mode de maintenance.

Point de terminaison de l’API

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

Voir URL de base pour le chemin du point de terminaison racine.

En-têtes de requête.

En-tête	Valeur (Value)
Autorisation	Porteur <access_token>
Type de contenu	application/json
X-UiPath-Interne-IdLocataire	<tenant_id>
X-UiPath-CléDossier	<folder_key>

Remarque :

Remplacez toutes les valeurs entre les chevrons <...> par leurs valeurs de cas d’utilisation correspondantes.

L’autorisation <access_token> est celle que vous avez reçue lorsque vous avez autorisé l’application externe avec l’étendue Apps ou Apps.Write et l’étendue OR.Folders.Read . Elle est disponible pendant 1 heure, puis vous devez en générer une nouvelle ou demander un jeton d’actualisation.

Variables de chemin d'accès

Variable de chemin d’accès	Type de données	Description
ID d'application déployé (obligatoire)	string	L'ID de déploiement de l'application à modifier.

Corps de la requête (obligatoire)

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

Champ	Type de données	Description
Version (obligatoire)	number	La version à définir pour l’application déployée.
Titre (obligatoire)	string	Le titre d'affichage de l'application déployée.
description (obligatoire)	string	La description de l'application déployée.
DonnéesModeService (facultatif)	object	Configuration du mode de maintenance.
maintenanceModeData.isMaintenanceModeEnabled	boolean	Indique si le mode de maintenance est activé.
MaintenanceModeData.MaintenanceModeUrl	string	L’URL vers laquelle rediriger les utilisateurs pendant la maintenance.
maintenanceModeData.maintenanceExcludedUsers	array	Utilisateurs exclus de la redirection de maintenance.
balises (facultatif)	string[]	Liste complète des valeurs de balises système. Remplace toutes les balises existantes.

Réponses

200 OK

Renvoie l’ID de l’application déployée mise à jour.

{
  "id": "string"
}

401 Non autorisé

Votre authentification n’est pas requise. Assurez-vous d’utiliser un jeton d’accès valide avec l’étendue Apps ou Apps.Write .

403 Forbidden

Vous ne disposez pas de l’autorisation requise pour modifier les applications déployées dans le dossier spécifié.