Récupérer l'affectation du robot du locataire

Point de terminaison GET pour récupérer le nombre de runtimes de robot alloués et utilisés par un locataire spécifique.

Récupère le nombre de runtimes Unattended Robot alloués à un locataire spécifique et, lorsqu'il est disponible, combien d'entre eux sont actuellement utilisés. Le nombre d'utilisations est lu en direct dans Orchestrator à chaque appel. Requiert l'un des éléments suivants:

• Une application externe avec l’étendue PM.License.Read (ou PM.License). Découvrez comment créer une application externe.
• Un jeton d'utilisateur de l'administrateur de l'organisation.
• Un jeton interne de service à service.

Point de terminaison de l’API

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

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Remarque :

{organizationName} et {accountId} identifient tous deux la même organisation: {organizationName} est le nom de l'organisation dans le préfixe de routage d'URL, tandis que {accountId} est l'ID de l'organisation utilisé comme paramètre de chemin. L’ID de l’organisation est également accepté dans le préfixe de routage, comme dans toute URL standard.

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'

Remarque :

Pour obtenir l' {access_token} pour une application externe, authentifiez-vous à l'aide de l'octroi d'informations d'identification du client, comme décrit sur la page Méthodes d'authentification.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
accountId (requis)	GUID	L'ID de l'organisation dans laquelle réside le locataire.
tenantId (requis)	GUID	L'ID du locataire pour lequel récupérer l'affectation du Robot.

Réponses

200 OK

Renvoie l'affectation du robot pour le locataire spécifié.

• serviceScopeId: l'ID de locataire de la requête.
• serviceType: toujours orchestrator.
• usageAvailable: true lorsque les comptages en cours d'utilisation ont été récupérés à partir d'Orchestrator. false lorsqu'Orchestrator n'est pas accessible; dans ce cas, inUse est omis de chaque entrée dans robots afin que l'utilisation indisponible ne soit jamais signalée comme zéro.
• robots: pour chaque type de Unattended Robot alloué au locataire, la quantité attribuée (allocated) et, lorsqu'elle est disponible, la quantité actuellement utilisée (inUse). Seuls les produits attribués au locataire sont répertoriés. Voir Robots pour les codes disponibles.

robots est renvoyé sous la forme d'un tableau vide, avec usageAvailable défini sur false, lorsque le locataire ne dispose pas de licence de service Orchestrator ou qu'aucune licence Unattended Robot n'a été attribuée. Dans ce cas, aucun appel n'est effectué vers Orchestrator.

Remarque :

Ce point de terminaison couvre uniquement les runtimes UnattendedUNATT NONPRUNATT-HOSTINGTAUNATTAPPTESTRRobot. Les licences Attended et autres licences d'utilisateur nommé ne sont pas incluses, car il s'agit de licences d'utilisateur, et non de runtimes. Elle renvoie également l'affectation pour un locataire par appel: pour récupérer l'affectation du robot pour chaque locataire d'une organisation, appelez le point de terminaison une fois par locataire.

Exemple de requête

La requête doit ressembler à l'exemple suivant (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}'

Voici le corps de la réponse pour une récupération réussie de l'affectation du robot:

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