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.

Registre uip api-workflow

Syntaxe et options pour `uip api-workflow registry` et `shub`, qui recherchent les activités connecteur/DAP et génèrent des objets d'activité prêts à être collés pour un fichier JSON de workflow d'API.

uip api-workflow registry recherche les activités de DAP/connecteur (typeCache de Studio Web) et génère des échantillons d'activité en forme de workflow d'API que vous collez directement dans le tableau Sequence_1.do d'un workflow. Flux type: resolve un mot-clé pour trouver une activité candidat, puis stub son uiPathActivityTypeId pour obtenir l'objet prêt à être collé.

Pour les activités de fournisseur (« IntSvc»), obtenez une UUID de connexion via uip is connections list <connector-key> et vérifiez-la avec uip is connections ping <uuid> avant de transmettre --connection-id. Le type Http ne nécessite aucune connexion. Les activités génériques (activityType: "Generic" dans resolve ) appliquent une opération (liste/créer/récupérer/mettre à jour/supprimer/...) à un objet de connecteur que vous choisissez via --object-name — découvrir les objets avec uip is resources list <connector-key> --connection-id <uuid>

Synthèse​

uip api-workflow registry resolve <keyword> [options]
uip api-workflow registry stub    <activity-type-id> [options]
uip api-workflow registry resolve <keyword> [options]
uip api-workflow registry stub    <activity-type-id> [options]

Résolution du registre de workflow d’API uip​

Search the API-workflow-compatible TypeCache by keyword and return candidate activities and triggers. Triggers live in a separate TypeCache catalog, so an activity-only search never returns them.

Arguments​

NomRequisObjectif
<keyword>ouiSubstring matched against display name, connector key, object name, or event operation.

Options​

DrapeauDescription
-l, --limit <n>Nombre maximal de résultats à renvoyer. Par défaut 50.
--kind <kind>Catalog to search: activity, trigger, or all. Default all.

Exemples​

uip api-workflow registry resolve "send email"

# Search only the trigger catalog
uip api-workflow registry resolve "created" --kind trigger
uip api-workflow registry resolve "send email"

# Search only the trigger catalog
uip api-workflow registry resolve "created" --kind trigger

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

{
  "Code": "ActivityResolveSuccess",
  "Data": {
    "Keyword": "send email",
    "Kind": "all",
    "ResultCount": 3,
    "Matches": []
  }
}
{
  "Code": "ActivityResolveSuccess",
  "Data": {
    "Keyword": "send email",
    "Kind": "all",
    "ResultCount": 3,
    "Matches": []
  }
}

Each match carries kind, either activity or trigger. Trigger matches also carry eventOperation, the connector event such as CREATED, and eventMode, either polling or webhooks. When a catalog is skipped, for example an unreachable trigger catalog, Data.Warnings says why.

es baser de registre d’api-workflow uip​

Saisissez un objet d'activité prêt à être collé pour un objet uiPathActivityTypeId connu. Combine TypeCache (paramètres GUID et instances) avec les métadonnées d'éléments Integration Service (chemin complet, champs, multipart). Sélectionne le type Http pour le connecteur HTTP et le type IntSvc pour les connecteurs de fournisseur.

Arguments​

NomRequisObjectif
<activity-type-id>ouiuiPathActivityTypeId renvoyé par resolve.

Options​

DrapeauDescription
--connection-id <id>UUID de connexion. Obligatoire pour les activités de fournisseur de type IntSvc.
--instance <n>Numéro d'instance, utilisé pour créer la clé d'emplacement et le suffixe du compartiment d'exportation. Par défaut 1.
--slot-key <key>Remplacez la clé d'emplacement PascalCase par défaut, par exemple GetNewestEmail_1.
--inputs <json>Mappage des noms de champ d'objet JSON aux valeurs, par exemple '{"message.subject":"hi"}'.
--object-name <name>Objet connecteur cible pour les activités Generic, par exemple tickets. Par défaut, l'objet épinglé dans la définition de l'activité, lorsqu'il est présent.
--resource-key <field>=<key>Liez un champ de sélecteur de ressource de solution à une clé de ressource de solution. Répétable, par exemple --resource-key 'ReleaseName=87ec3255-...'.

Exemple​

uip api-workflow registry stub SendEmail --connection-id 87ec3255-1234-4abc-9def-0123456789ab
uip api-workflow registry stub SendEmail --connection-id 87ec3255-1234-4abc-9def-0123456789ab

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

{
  "Code": "ActivityStubSuccess",
  "Data": {
    "kind": "IntSvc",
    "slotKey": "SendEmail_1",
    "exportBucketKey": "SendEmail_1_output",
    "activity": {},
    "parameters": {},
    "requestFields": [],
    "responseFields": []
  }
}
{
  "Code": "ActivityStubSuccess",
  "Data": {
    "kind": "IntSvc",
    "slotKey": "SendEmail_1",
    "exportBucketKey": "SendEmail_1_output",
    "activity": {},
    "parameters": {},
    "requestFields": [],
    "responseFields": []
  }
}

Les clés de l'objet Activity sont conservées dans leur camelCase native (pas PascalCase comme la plupart des sorties de cette CLI) — elle est collée dans le tableau textuel dans le tableau do[] d'un workflow, et PascalCasing arrêterait l'exécuteur. Lorsque --resource-key sélections sont fournies, la réponse ajoute un tableau SolutionResourceFields; lorsque la recherche fait apparaître des opportunités d'enrichissement ou des mises en garde, elle ajoute IsEnrichmentAvailable et/ou Warnings.

Voir également​

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

Connecter

Besoin d'aide ? Assistance(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour