检查应用程序名称唯一性

用于检查已部署的应用程序路由名称在组织中是否唯一的 API 参考。

检查给定的路由名称对于组织中已部署的应用程序是否唯一。如果该名称已在使用中，则响应还会返回保存该名称的已部署应用程序。

API 端点

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

有关根端点路径，请参阅基本 URL 。

请求标头

页眉	值
授权	承载 <your-access-token>
X-UiPath-内部租户 ID	<tenant_id>

备注：

将尖括号 <...> 之间的所有值替换为其相应的用例值。

<access_token>是您在授权具有Apps或Apps.Read作用域的外部应用程序时收到的 。有效期为 1 小时，然后您需要生成新令牌，或请求刷新令牌。

路径变量

路径变量	数据类型	描述
路由名称（必填）	string	要检查唯一性的路由名称。

响应

200 OK

如果路由名称可用，则occupiedBy为null ：

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

如果路由名称已在使用中， occupiedBy将返回保存该路由的已部署应用程序：

{
  "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"
  }
}

字段	数据类型	描述
为唯一	boolean	true 如果路由名称可用，则false如果已被使用）。
占用者	object	保存路由名称的已部署应用程序。当null为isUnique时， true 。如果无法加载保存该名称的应用程序，则当isUnique为false时，也可以为null 。
占用的.id	string	应用程序的部署 ID。
AttendedBy.systemName	string	应用程序的系统名称。
占用的标题	string	已发布应用程序的标题。
AttendedBy.deploymentTitle	string	部署时为应用程序指定的名称。
AttendedBy.deploymentDescription	string	已部署应用程序的描述。
AttendedBy.deployVersion	number	已部署的版本号。
AttendedBy.semVersion	string	已部署应用程序的语义版本。
AttendedBy.dateDeployed	string	应用程序的部署日期和时间，采用 ISO 8601 格式。
AttendedBy.deploymentFolder	object	部署应用程序的文件夹。
AttendedBy.deploymentFolder.key	string	文件夹密钥。
AttendedBy.deploymentFolder.id	number	文件夹 ID。
AttendedBy.deploymentFolder.displayName	string	文件夹的显示名称。
AttendedBy.deploymentFolder.fullyQualifiedName	string	文件夹的完整路径。
AttendedBy.isAppPublic	boolean	true 该应用程序可公开访问。
占用By.isLatestVersion	boolean	true 如果部署的版本是最新发布的版本。
AttendedBy.isResourceActivated	boolean	false 如果已停用已部署的应用程序。已停用的应用程序仍保留其路由名称。并非在每个应用程序上都存在。如果缺少该字段，则应用程序处于活动状态。
AttendedBy.routingName	string	应用程序 URL 中使用的路由名称。

400 Bad Request

routingName路径变量为空或仅包含空格。

401 未经授权

您未通过身份验证。确保您使用的是具有Apps或Apps.Read作用域的有效访问令牌。

403 Forbidden

您无权检查指定组织中应用程序名称的唯一性。