テナントのロボットの割り当てを取得

特定のテナントに割り当てられ、特定のテナントによって使用中のロボット ランタイムの数を取得するための GET エンドポイントです。

特定のテナントに割り当てられている Unattended ロボット ランタイムの数と、利用可能な場合は現在使用中のランタイムの数を取得します。使用中のカウントは、各呼び出しで Orchestrator からライブで読み取られます。以下のいずれかが必要です。

• スコープが PM.License.Read (または PM.License) の外部アプリケーション。外部アプリケーションの作成方法について詳しくは、こちらをご覧ください。
• 組織管理者のユーザー トークン。
• 内部のサービス間トークン。

API エンドポイント

GET {accessURL}/{organizationName}/license_/api/account/{accountId}/tenant/{tenantId}/robots

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud (公共部門向け)	https://govcloud.uipath.us/
Automation Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

注:

{organizationName} と {accountId} はどちらも同じ組織を識別します。 {organizationName} は URL ルーティング プレフィックスの組織名で、 {accountId} はパス パラメーターとして使用される組織 ID (GUID) です。組織 ID は、他の標準 URL と同様に、ルーティング プレフィックスにも使用できます。

要求ヘッダー

--header 'Authorization: Bearer {access_token}'

注:

外部アプリケーションの {access_token} を取得するには、「 認証方法」ページの説明に従って、クライアント資格情報の付与を使用して認証します。

パス パラメーター

パス パラメーター	データ型	説明
accountId (必須)	GUID	テナントが存在する組織の ID です。
tenantId (必須)	GUID	ロボットの割り当てを取得するテナントの ID。

応答

200 OK

指定したテナントに対するロボットの割り当てを返します。

• serviceScopeId: 要求のテナント ID です。
• serviceType: 常に orchestratorです。
• usageAvailable: 使用中の数が Orchestrator から取得された日時に true されます。Orchestrator にアクセスできなかった場合のfalse。その場合、robotsのすべてのエントリからinUseが省略されるため、使用できない使用量がゼロとして報告されることはありません。
• robots: テナントに割り当てられている Unattended ロボットの種類ごとに、割り当てられた数量 (allocated)、および利用可能な場合は現在使用中の数量 (inUse) です。テナントに割り当てられている製品のみが表示されます。利用可能なコードについては、「 Robots 」をご覧ください。

テナントに Orchestrator サービス ライセンスusageAvailableない場合、または Unattended ロボット ライセンスが割り当てられていない場合、robots は空falseの配列として返されます。その場合、Orchestrator への呼び出しは行われません。

注:

このエンドポイントは Unattended ロボット ランタイムのみを対象としています (UNATT、 NONPR、 UNATT-HOSTING、 TAUNATT、 APPTESTR)。Attended およびその他の Named User ライセンスは含まれません。これらはランタイムではなくユーザー ライセンスであるためです。また、1 回の呼び出しごとに 1 つのテナントの割り当てを返します。組織内のすべてのテナントのロボットの割り当てを取得するには、テナントごとに エンドポイントを 1 回呼び出します。

要求の例

要求は次の例のようになります (cURL)。

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/11111111-1111-1111-1111-111111111111/tenant/22222222-2222-2222-2222-222222222222/robots' \
--header 'Authorization: Bearer {access_token}'

ロボットの割り当ての取得が成功した場合の応答本文は次のとおりです。

{
  "serviceScopeId": "22222222-2222-2222-2222-222222222222",
  "serviceType": "orchestrator",
  "usageAvailable": true,
  "robots": [
    { "code": "UNATT", "allocated": 10, "inUse": 3 },
    { "code": "NONPR", "allocated": 2, "inUse": 0 }
  ]
}