アプリ名の一意性を確認する

デプロイ済みのアプリのルーティング名が組織内で一意であるかどうかを確認するための API リファレンスです。

指定したルーティング名が組織内にデプロイされたアプリで一意であるかどうかを確認します。名前がすでに使用中の場合、応答は、その名前を保持するデプロイ済みのアプリも返します。

API エンドポイント

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

「ルート エンドポイント パスの ベース URL 」をご覧ください。

要求ヘッダー

ヘッダー	値 (Value)
認可	Bearer <your-access-token>
X-UiPath-Internal-TenantId	<tenant_id>

注:

角括弧で囲まれた値 <...> をすべて、対応するユース ケース値に置き換えます。

この <access_token> は、 Apps スコープまたは Apps.Read スコープで外部アプリケーションを認可したときに受け取ったものです。このアクティビティは 1 時間利用可能です。その後は新しいトークンを生成するか、更新トークンをリクエストする必要があります。

Path 変数

Path 変数	データ型	説明
routingName (必須)	string	一意性を確認するルーティング名。

応答

200 OK

ルーティング名が利用可能な場合は、 occupiedBynullになります。

{
  "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 、そのルーティング名がすでに使用されているかどうか。
occupiedBy	object	ルーティング名を保持するデプロイ済みのアプリ。isUnique がtrueの場合にnullします。また、isUnique がfalseの場合に、 という名前を保持しているアプリを読み込めなかった場合にnullすることもできます。
occupiedBy.id	string	アプリのデプロイ ID です。
occupiedBy.systemName	string	アプリのシステム名です。
occupiedBy.title	string	パブリッシュ済みのアプリのタイトルです。
occupiedBy.deploymentTitle	string	アプリがデプロイされたときに付けられた名前です。
occupiedBy.deploymentDescription	string	デプロイ済みのアプリの説明です。
occupiedBy.deployVersion	number	デプロイされたバージョン番号。
occupiedBy.semVersion	string	デプロイ済みのアプリのセマンティック バージョンです。
occupiedBy.dateDeployed	string	アプリがデプロイされた日時 (ISO 8601 形式)。
occupiedBy.deploymentFolder	object	アプリがデプロイされているフォルダー。
occupiedBy.deploymentFolder.key	string	フォルダー キーです。
occupiedBy.deploymentFolder.id	number	フォルダー ID です。
occupiedBy.deploymentFolder.displayName	string	フォルダーの表示名です。
occupiedBy.deploymentFolder.fullyQualifiedName	string	フォルダーのフル パスです。
occupiedBy.isAppPublic	boolean	true アプリが誰でもアクセス可能かどうか。
occupiedBy.isLatestVersion	boolean	true デプロイされたバージョンが最新のパブリッシュ済みバージョンの場合。
occupiedBy.isResourceActivated	boolean	false デプロイ済みのアプリが非アクティブ化されている場合。非アクティブ化されたアプリでも、ルーティング名は保持されます。すべてのアプリに存在するわけではありません。フィールドがない場合、アプリはアクティブです。
occupiedBy.routingName	string	アプリの URL で使用されるルーティング名。

400 Bad Request

routingName path 変数が空であるか、空白のみが含まれています。

401 未承認

認証されていません。Apps または Apps.Read のスコープで有効なアクセス トークンを使用していることを確認してください。

403 Forbidden

指定した組織内でアプリ名の一意性を確認する権限がありません。