UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

uip est connecteurs

Syntaxe et options de `uip is connectors`, qui parcourt le catalogue de connecteurs Integration Service et inspecte les métadonnées de découverte, le schéma et l'historique d'audit d'un connecteur.

uip is connectors parcourt le catalogue de connecteurs Integration Service — chaque intégration à laquelle le locataire peut s'authentifier (Salesforce, Slack, Zoho Desk, etc.) — et inspecte les métadonnées de découverte d'un connecteur, le document OpenAPI, les opérations d'événements et l'historique d'audit. Il est en lecture seule: aucun de ces verbes ne crée ou ne modifie un connecteur. list met en cache son résultat par locataire sur le disque; transmettez --refresh pour forcer une nouvelle extraction. get et tous les autres verbes ci-dessous appellent toujours l'API directement et ne touches jamais ce cache.

Synthèse​

uip is connectors <verb> [options]
uip is connectors <verb> [options]

Verbes​

VerbeObjectif
listLister les connecteurs disponibles au locataire; éventuellement filtrer par nom ou par clé.
getRécupérez les détails complets d'un connecteur par clé.
metadataRécupérez les métadonnées de découverte d'un connecteur (indicateurs de capacité, niveau, type de découverte).
swaggerRécupérez le document OpenAPI d'un élément de connecteur.
event-operationsRépertorie les opérations d'événement prises en charge par un élément de connecteur.
audit-logsRépertoriez les entrées de journal d’audit d’une version d’élément de connecteur.
exportExportez le package d'un élément de connecteur vers un fichier local.

uip est une liste de connecteurs​

Répertoriez les connecteurs disponibles au locataire actuel. Mis en cache par locataire sur le disque.

Options​

ShortLongValeur (Value)DefaultDescription
-f--filtertext—Correspondance de sous-chaîne avec le nom ou la clé du connecteur.
—--refreshDrapeaudésactivéForcer la réextraction à partir de l’API, en ignorant le cache.

Exemples​

uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'
uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'

Format des données (--sortie json)​

{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}
{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}

Si aucun connecteur ne correspond, la commande réussit avec Code: "Message" et Data: { "Message": "No connectors found." }.

uip est que les connecteurs obtiennent​

Renvoyez l'enregistrement complet d'un connecteur par clé. Appelle toujours l'API directement - non mise en cache.

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur, par exemple uipath-zoho-desk. Trouvez-le avec connectors list.

Options​

Aucun au-delà des options globales.

Exemples​

uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'
uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'

Format des données (--sortie json)​

{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}
{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}

Liste complète des champs (tous les champs renvoyés): Id, Name, Key, AppName, Vendor, Description, Image, Active, HasEvents, HasCruds, HasMethods, HasHttpRequest, DapCompatible, Categories, Tags, DocumentationUrl. Description lit "No description" et DocumentationUrl lit "No documentation" lorsque le catalogue n'a rien de fichier pour ce connecteur, plutôt qu'une chaîne vide.

uip est les métadonnées des connecteurs​

Récupérer les métadonnées de découverte d'un connecteur: indicateurs de capacité (prend-il en charge les événements, CRUD, découverte d'objets/champs personnalisés,...), niveau, type de découverte et tous les indicateurs de fonctionnalité spécifiques au locataire.

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur, par exemple uipath-salesforce-sfdc.

Options​

Aucun au-delà des options globales.

Exemple​

uip is connectors metadata uipath-salesforce-sfdc
uip is connectors metadata uipath-salesforce-sfdc

Format des données (--sortie json)​

{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}
{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}
Remarque :

La commande expose chaque propriété booléenne renvoyée par le catalogue pour un connecteur, et pas seulement l'ensemble fixe indiqué ci-dessus — un nouvel indicateur de capacité ajouté au catalogue s'affiche ici automatiquement sans attendre la version de la CLI.

uip est connecteurs swagger​

Récupérez le document OpenAPI décrivant les opérations d’un élément connecteur.

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur.

Options​

LongValeur (Value)Description
--versiontextVersion de l’élément. Omettez cette option pour utiliser la version par défaut/dernière version du connecteur.

Exemple​

uip is connectors swagger uipath-zoho-desk
uip is connectors swagger uipath-zoho-desk

Format des données (--sortie json)​

{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}
{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}

Data est le document OpenAPI brut renvoyé par le catalogue - sa forme suit les spécifications OpenAPI, et non les conventions d'enveloppe PascalCase habituelles de cette CLI.

uip est connecteurs event-operations​

Répertoriez les opérations d'événement prises en charge par un élément de connecteur (les opérations disponibles pour uip is triggers pour ce connecteur).

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur.

Options​

LongValeur (Value)Description
--versiontextVersion de l’élément. Omettez cette option pour utiliser la version par défaut/dernière version du connecteur.

Exemple​

uip is connectors event-operations uipath-zoho-desk
uip is connectors event-operations uipath-zoho-desk

Format des données (--sortie json)​

{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}
{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}

Un résultat vide réussit toujours, avec Instructions: "No event operations found for connector '<connector-key>'.".

uip est connecteurs audit-logs​

Répertoriez les entrées du journal d’audit enregistrées pour une version d’élément de connecteur (modifications de schéma, publications et événements similaires côté catalogue).

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur.

Options​

LongValeur (Value)Description
--versiontextRequis. Version de l’élément pour laquelle récupérer les journaux d’audit.
--limitNumériqueTaille de la page.
--next-pageJetonCurseur à partir d'une réponse précédente pour récupérer la page suivante.

Exemple​

uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50
uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50

Format des données (--sortie json)​

{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "user@example.com" }
  ]
}
{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "user@example.com" }
  ]
}

Un résultat vide réussit toujours, avec Instructions: "No audit logs found for connector '<connector-key>' version '<version>'.".

uip est l'exportation des connecteurs​

Exportez le package d'un élément de connecteur vers un fichier local.

Arguments​

NomRequisObjectif
<connector-key>ouiClé du connecteur.

Options​

LongValeur (Value)Description
--output-fileChemin d'accèsRequis. Chemin du fichier de destination.
--versiontextVersion de l’élément. Omettez cette option pour utiliser la version par défaut/dernière version du connecteur.

Exemple​

uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip
uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip

Format des données (--sortie json)​

{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}
{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}

Version renvoie ce qui a été transmis --version (chaîne vide si omise): il ne se résout pas vers le numéro de version exporté réel.

  • uip is connections — Créez des sessions OAuth pour les connecteurs découverts ici.
  • uip is activities — répertorie les opérations qu'un connecteur expose.
  • uip is resources — décrivent et exécutez les objets du plan de données d'un connecteur.
  • uip is triggers — opérations du connecteur centrées sur les événements, soutenues par event-operations ci-dessus.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour