exécution du workflow d’API uip

Syntaxe et options de `uip api-workflow run`, qui exécute un fichier JSON de workflow d'API localement à l'aide de l'exécuteur de workflow sans serveur fourni.

uip api-workflow run exécute un fichier JSON de workflow d'API localement à l'aide de l'exécuteur de workflow sans serveur fourni. Les arguments d’entrée sont transmis au format JSON. Par défaut, l'exécuteur charge les informations d'identification UiPath à partir de la session uip login afin que le workflow puisse atteindre les connecteurs et les services basés sur le cloud; transmettez --no-auth pour ignorer le chargement des informations d’identification et exécuter en mode local uniquement.

Synthèse

uip api-workflow run <file> [options]

• <file> : le chemin d'accès au fichier JSON du workflow.

Options

Drapeau	Description
-i, --input-arguments <json>	Arguments d'entrée sous la forme d'une chaîne JSON, par exemple '{"name": "World"}'.
--input-file <name=path>	Chargez un fichier local et transmettez-le comme entrée de fichier (JobAttachment) <name>. Répétable pour plusieurs fichiers. Nécessite une session connectée.
--output-dir <dir>	Téléchargez chaque référence de fichier (JobAttachment) dans la sortie du workflow dans <dir>; chaque référence téléchargée obtient un LocalPath. Nécessite une session connectée.
--folder-key <guid>	Clé de dossier Orchestrator pour les pièces jointes créées par cette exécution (entrées et fichiers téléchargés et écrits par les activités Fichier vers Base64 / Base64 vers Fichier).
--no-auth	Ignorer le chargement des informations d’identification. Le workflow s’exécute en mode local uniquement sans accès aux connecteurs ni aux services basés sur le cloud (désactive également --input-file/--output-dir).

Exemples

# Run with an inline input object
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}'

# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth

# Extract just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'

# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
    --input-file document=./invoice.pdf \
    --output-dir ./out

Format des données (--sortie json)

{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}

Status reflète l'état terminal de l'exécuteur (Completed, Faulted, etc.). Une exécution défaillante se termine non-zéro selon les codes de sortie standard.

Lorsque la sortie du workflow inclut une référence de fichier (JobAttachment) et que --output-dir est défini, la forme se concentre plutôt sur le fichier téléchargé:

{
  "Code": "WorkflowRun",
  "Data": {
    "Encoded": {
      "Id": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}

LocalPath n'est renseigné que lorsque --output-dir est défini — sans elle, la référence est renvoyée sans fichier local.

Associé

• uip api-workflow build — compiler le projet avant de l'exécuter.
• uip api-workflow pack — empaqueter un workflow validé pour la publication.

Voir également

• Présentation de l’outil de workflow d’API
• Options globales
• Codes de sortie
• uip login — informations d'identification chargées par run sauf si --no-auth est défini.