Editar um aplicativo implantado

Edita as propriedades de um aplicativo implantado, como título, descrição, versão e configurações do modo de manutenção.

Ponto de Extremidade da API

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

Consulte URL base para obter o caminho do endpoint raiz.

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <access_token>
Tipo de conteúdo	application/json
IdX-UiPath-Internal-Tenant	<tenant_id>
X-UiPath-FolderKey	<folder_key>

Observação:

Substitua todos os valores entre os colchetes angulares <...> por seus valores de caso de uso correspondentes.

O <access_token> é aquele que você recebeu quando autorizou o aplicativo externo com o escopo Apps ou Apps.Write e o escopo OR.Folders.Read . Ele estará disponível por 1 hora. Depois, você precisa gerar um novo ou solicitar um token de atualização.

Variáveis de caminho

Variável Path	Tipo de dados	Description
startedAppId (obrigatório)	string	O ID da implantação do aplicativo a ser editado.

Corpo da solicitação (obrigatório)

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

Campo	Tipo de dados	Description
version (obrigatório)	number	A versão a ser definida para o aplicativo implantado.
título (obrigatório)	string	O título de exibição do aplicativo implantado.
descrição (obrigatório)	string	A descrição do aplicativo implantado.
dadosDeModoDeManutenção (opcional)	object	Configuração do modo de manutenção.
keepModeData.isMaintenanceModeEnabled	boolean	Se o modo de manutenção está habilitado.
ManutençãoModeDados.maintenanceModeUrl	string	O URL para redirecionar os usuários durante a manutenção.
tenantModeData.maintenanceExcludedUsers	array	Usuários excluídos do redirecionamento de manutenção.
tags (opcional)	string[]	Lista completa de valores de tags do sistema. Substitui todas as tags existentes.

Resposta

200 OK

Retorna o ID do aplicativo implantado atualizado.

{
  "id": "string"
}

401 não autorizado

Você não foi autenticado. Certifique-se de estar usando um token de acesso válido com o escopo Apps ou Apps.Write .

403 Forbidden

Você não tem permissão para editar os aplicativos implantados na pasta especificada.