Verificar a exclusividade do nome do aplicativo

Referência de API para verificar se um nome de roteamento de app implantado é exclusivo dentro da organização.

Verifica se um nome de roteamento fornecido é exclusivo para apps implantados na organização. Se o nome já estiver em uso, a resposta também retornará o aplicativo implantado que o contém.

Ponto de Extremidade da API

GET <BaseURL>/models/deployed/apps/uniquename/check/{routingName}

Consulte URL base para obter o caminho do endpoint raiz.

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <your-access-token>
IdX-UiPath-Internal-Tenant	<tenant_id>

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.

Variáveis de caminho

Variável Path	Tipo de dados	Description
roteamentoNome (obrigatório)	string	O nome de roteamento para verificar a exclusividade.

Resposta

200 OK

Se o nome de roteamento estiver disponível, occupiedBy é null:

{
  "isUnique": true,
  "occupiedBy": null
}

Se o nome de roteamento já estiver em uso, occupiedBy retorna o aplicativo implantado que o contém:

{
  "isUnique": false,
  "occupiedBy": {
    "id": "string",
    "systemName": "string",
    "title": "string",
    "deploymentTitle": "string",
    "deploymentDescription": "string",
    "deployVersion": 1,
    "semVersion": "string",
    "dateDeployed": "string",
    "deploymentFolder": {
      "key": "string",
      "id": 1,
      "displayName": "string",
      "fullyQualifiedName": "string"
    },
    "isAppPublic": false,
    "isLatestVersion": true,
    "isResourceActivated": true,
    "routingName": "string"
  }
}

Campo	Tipo de dados	Description
É exclusivo	boolean	true se o nome de roteamento estiver disponível, false se já estiver em uso.
OcupadoPor	object	O aplicativo implantado que contém o nome de roteamento. null quando isUnique for true. Também pode ser null quando isUnique for false, se o aplicativo contendo o nome não puder ser carregado.
ocupadoPor.id	string	O ID de implantação do aplicativo.
ocupadoPor.sistemaNome	string	O nome do sistema do aplicativo.
ocupadoPor.título	string	O título do aplicativo publicado.
ocupadoPor.deploymentTitle	string	O nome que o aplicativo recebeu quando foi implantado.
OcupadoPor.descriçãoDaDeployment	string	A descrição do aplicativo implantado.
ocupadoPor.deployVersion	number	O número da versão implantada.
ocupadoPor.semVersão	string	A versão semântica do aplicativo implantado.
tenantBy.date Implantado	string	A data e a hora em que o aplicativo foi implantado, no formato ISO 8601.
ocupadoPor.pastaDeDeployment	object	A pasta em que o aplicativo será implantado.
tenantBy.deploymentFolder.key	string	A chave da pasta.
tenantBy.deploymentFolder.id	number	O ID da pasta.
ocupadoPor.deploymentFolder.displayName	string	O nome de exibição da pasta.
tenantBy.deploymentFolder.llyQualifiedName	string	O caminho completo da pasta.
ocupadoPor.isAppPúblico	boolean	true se o aplicativo estiver acessível publicamente.
tenantBy.isLatestVersion	boolean	true se a versão implantada for a versão mais recente publicada.
OcupadoPor.isRecursoAtivado	boolean	false se o aplicativo implantado estiver desativado. Um aplicativo desativado ainda mantém seu nome de roteamento. Não presente em todos os aplicativos. Se o campo estiver ausente, o aplicativo estará ativo.
ocupadoPor.routingName	string	O nome de roteamento usado no URL do app.

400 Bad Request

A variável de caminho routingName está vazia ou contém apenas espaços em branco.

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 verificar a exclusividade do nome do app na organização especificada.