UiPath Documentation
apps
latest
false
Guia da API do Apps
  • API do Apps
Importante :
Para obter documentação sobre projetos de aplicativos no Studio Web, consulte o capítulo Projetos de aplicativos na documentação do Studio Web: https://docs.uipath.com/pt-BR/studio-web/automation-cloud/latest/user-guide/apps-in-studio-web. A tradução automática foi aplicada parcialmente neste conteúdo. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Obter aplicativos implantados

Recupera todos os aplicativos implantados em uma pasta.

Ponto de Extremidade da API

GET <BaseURL>/models/deployed/apps

Consulte URL base para obter o caminho do endpoint raiz.

Cabeçalhos de solicitação.

CabeçalhoValor
AutorizaçãoO portador <access_token>
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.Read . Ele estará disponível por 1 hora. Depois, você precisa gerar um novo ou solicitar um token de atualização.

Parâmetros de Consulta

Parâmetro de consultaTipo de dadosDescriptionValor padrão
superior (opcional)int32O número de resultados a serem retornados.N/A
pular (opcional)int32O número de resultados a serem ignorados.N/A
OrderBy (opcional)stringO campo pelo qual os resultados serão ordenados.N/A
SearchText (opcional)stringFiltra os resultados pelo texto de pesquisa especificado.N/A
tags (opcional)stringLista separada por vírgulas de valores de tags do sistema para filtrar.N/A

Resposta

200 OK

{
  "@odata.context": "string",
  "@odata.count": 1,
  "value": [
    {
      "id": "string",
      "appSystemName": "string",
      "title": "string",
      "description": "string",
      "version": 1,
      "routingName": "string",
      "tags": ["string"]
    }
  ]
}
{
  "@odata.context": "string",
  "@odata.count": 1,
  "value": [
    {
      "id": "string",
      "appSystemName": "string",
      "title": "string",
      "description": "string",
      "version": 1,
      "routingName": "string",
      "tags": ["string"]
    }
  ]
}
CampoTipo de dadosDescription
@odata.contextstringO URL do contexto do OData.
@odata.contagemnumberO número total de apps implantados que correspondem à consulta.
ValuearrayA lista de apps implantados.
valor[].idstringO ID de implantação do aplicativo.
valor[].AppSystemNamestringO nome do sistema do aplicativo.
valor[].títulostringO título de exibição do aplicativo implantado.
valor[].descriçãostringA descrição do aplicativo implantado.
valor[].versãonumberO número da versão implantada.
valor[].NomeDoRoutestringO nome de roteamento usado no URL do app.
valor[].tagsstring[]Os valores da tag do sistema anexados ao aplicativo implantado.

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.Read .

403 Forbidden

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

  • Ponto de Extremidade da API
  • Cabeçalhos de solicitação.
  • Parâmetros de Consulta
  • Resposta
  • 200 OK
  • 401 não autorizado
  • 403 Forbidden

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades