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.

automatisations uip ah, flux d'idées, cas métier, phases, questionnaires, pipelines

Syntaxe et options pour le cycle de vie de l'idée à la livraison d'Automation Hub — soumission et lecture des idées d'automatisation, transitions de phase, analyses coûts-avantages, le catalogue d'évaluation et la vue du pipeline classée en avantages.

Une automatisation (Automation Hub appelle l'enregistrement sous-jacent un « processus») est l'enregistrement principal dans Automation Hub — une idée soumise qui passe par des phases configurables (Idée, Évaluation, Analyse, Conception de solutions, Développement, Test, Dynamique, ...) via un flux d'idées. Chaque phase comporte une analyse coûts-avantages (cas métier) et une évaluation (ensemble de questions du catalogue de questionnaires ) capture les réponses qui alimentent une soumission. La vue du pipeline présente les automatisations ainsi que leurs chiffres d'exécution et d'avantages, classées. Voir uip ah pour les concepts partagés (projection/--all-fields, listes paginés ou non paginés, découverte de l'ID) qui s'appliquent à chaque verbe ici.

automatisations uip ah​

Travailler avec des idées d'automatisation — le dossier de base d'Automation Hub.

Synthèse​

uip ah automations list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--category-id <id...>] [--application-id <id...>] [--business-unit <name>] [--phase-id <id...>] [--status-id <id...>] [--tags <tag...>] [--owner-id <id>] [--submitter-id <id>] [--updated-by-id <id>] [--submission-type <type>] [--start-date <date>] [--end-date <date>] [--plain-text] [--high-level-assessment] [--advanced-information] [--limit <n>] [--offset <n>] [--all-fields]
uip ah automations get <automation-id> [--plain-text] [--all-fields]
uip ah automations schema get [automation-id] [--source-type <type>] [--idea-flow-id <id>] [--category-id <id>] [--destination <path>]
uip ah automations create --source-type <type> --file <json-file> [--from-schema] [--idea-flow-id <id>]
uip ah automations update <automation-id> --file <json-file>
uip ah automations list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--category-id <id...>] [--application-id <id...>] [--business-unit <name>] [--phase-id <id...>] [--status-id <id...>] [--tags <tag...>] [--owner-id <id>] [--submitter-id <id>] [--updated-by-id <id>] [--submission-type <type>] [--start-date <date>] [--end-date <date>] [--plain-text] [--high-level-assessment] [--advanced-information] [--limit <n>] [--offset <n>] [--all-fields]
uip ah automations get <automation-id> [--plain-text] [--all-fields]
uip ah automations schema get [automation-id] [--source-type <type>] [--idea-flow-id <id>] [--category-id <id>] [--destination <path>]
uip ah automations create --source-type <type> --file <json-file> [--from-schema] [--idea-flow-id <id>]
uip ah automations update <automation-id> --file <json-file>

liste des automatisations uip ah​

Lister des idées d'automatisation sur le locataire.

Options​
LongValeur (Value)Description
--search <text>stringRecherche en texte libre, comme sur l'écran Parcourir.
--sort-by <field>stringChamp à utiliser pour le tri, par exemple process_updated_epoch.
--sort-order <direction>asc|descChoisir l'ordre de tri.
--category-id <id...>RépétableUniquement les automatisations de ces catégories.
--application-id <id...>RépétableUniquement les automatisations utilisant ces applications.
--business-unit <name>stringUniquement les automatisations dans cette unité commerciale.
--phase-id <id...>RépétableUniquement les automatisations dans ces phases.
--status-id <id...>RépétableSeules les automatisations dans ces statuts de phase.
--tags <tag...>RépétableUniquement les automatisations qui comportent ces balises.
--owner-id <id>IntegerUniquement les automatisations appartenant à cet ID d'utilisateur.
--submitter-id <id>IntegerUniquement les automatisations soumises par cet ID utilisateur.
--updated-by-id <id>IntegerSeules les automatisations sont mises à jour par cet ID utilisateur.
--submission-type <type>stringUniquement ce type de soumission.
--start-date <date> / --end-date <date>YYYY-MM-DDCréé le jour ou après/avant cette date.
--plain-textDrapeauConvertissez les champs de texte enrichi en texte brut.
--high-level-assessmentDrapeauInclure des données d'évaluation de haut niveau.
--advanced-informationDrapeauInclure des réponses aux questions détaillées et personnalisées.
--limit <n> / --offset <n>IntegerPagination. Par défaut --limit 20.
--all-fieldsDrapeauRenvoyez la charge utile brute au lieu des champs projetés.
Exemple​
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
Format des données (--sortie json)​
{
  "Code": "AhAutomationsList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "Phase": "Analysis",
      "PhaseStatus": "In Progress", "SubmissionType": "ED", "BusinessUnit": "EMEA",
      "Department": "Finance", "AutomationScore": 78, "Priority": 1, "IsPublished": 0,
      "CreatedEpoch": 1735689600000, "UpdatedEpoch": 1738368000000,
      "PhaseKey": "ANALYSIS", "Tags": ["finance"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}
{
  "Code": "AhAutomationsList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "Phase": "Analysis",
      "PhaseStatus": "In Progress", "SubmissionType": "ED", "BusinessUnit": "EMEA",
      "Department": "Finance", "AutomationScore": 78, "Priority": 1, "IsPublished": 0,
      "CreatedEpoch": 1735689600000, "UpdatedEpoch": 1738368000000,
      "PhaseKey": "ANALYSIS", "Tags": ["finance"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

Tags est dérivé du tableau process_tags de l'enregistrement réel (ou de son homologue __display) dans un tableau de chaînes simple. PhaseKey est la valeur prise par uip ah phases set --phase.

uip ah - Obtenir les automatisations​

Obtenir une idée d'automatisation par ID.

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongDescription
--plain-textConvertissez les champs de texte enrichi en texte brut.
--all-fieldsRenvoyez la charge utile brute.
Exemple​
uip ah automations get 20 --plain-text
uip ah automations get 20 --plain-text
Format des données (--sortie json)​
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

Obtenir le schéma d’automatisations uip ah​

Obtenez un schéma d'évaluation — le document que create/update utilise. Avec un identifiant d’automatisation, il renvoie le formulaire rempli de cette automatisation; sans un, il renvoie un modèle vierge pour --source-type.

Arguments​
NomRequisObjectif
[automation-id]nonIdentifiant de l'automatisation existant, pour lire son schéma rempli. Omettre pour un modèle vierge.
Options​
LongValeur (Value)Description
--source-type <type>COE|ED|CD|PM|TMRequis pour un modèle vierge (aucun identificateur d'automatisation fourni).
--idea-flow-id <id>IntegerIdentifiant du flux d'idées, pour un flux personnalisé.
--category-id <id>IntegerID de catégorie pour choisir l'évaluation active.
--destination <path>Chemin d'accèsÉcrivez le schéma JSON dans ce fichier au lieu de l'enveloppe de sortie.

Il est obligatoire de spécifier soit un identifiant d'automatisation, soit --source-type; la transmission n'échoue pas côté client avant toute requête.

Exemple​
uip ah automations schema get --source-type COE --destination ./idea.json
uip ah automations schema get --source-type COE --destination ./idea.json
Format des données (--sortie json)​
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }

Lorsque --destination est omis, Data.Schema porte le document de schéma en ligne au lieu de Destination.

création d'automatisations uip ah​

Soumettre une nouvelle idée d’automatisation. --source-type sélectionne le formulaire de soumission à forme fixe (ED→/automationidea, COE→/coe-automationidea, PM→/processmining-idea); --from-schema soumet un document schema get rempli via /idea-from-schema à la place — requis pour les types de source CD/TM et pour tout locataire avec des flux d'idées personnalisés via --idea-flow-id.

Options​
LongValeur (Value)RequisDescription
--source-type <type>COE|ED|CD|PM|TMConditionnelObligatoire, sauf si --idea-flow-id est indiqué à la place.
--file <json-file>Chemin d'accèsouiCorps de la requête — le fichier JSON à forme fixe ou le document user_inputs rempli avec --from-schema.
--from-schemaDrapeaunonSoumettez via le point de terminaison du schéma à l’aide du document de automations schema get.
--idea-flow-id <id>IntegernonFlux d’idées cible pour --from-schema — remplace --source-type pour les locataires avec des flux personnalisés. Nécessite --from-schema. Conflit avec --source-type.

--idea-flow-id sans --from-schema échoue côté client (les points de terminaison de forme fixe n’ont aucune notion de flux d’idées). Un objet --file dont le JSON comporte déjà une clé user_inputs est déencapsulé automatiquement; un fichier contenant uniquement la carte des réponses est utilisé tel quel.

Exemple​
uip ah automations create --source-type ED --file ./idea.json
uip ah automations create --source-type ED --file ./idea.json
Format des données (--sortie json)​
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

mise à jour des automatisations uip ah​

Mettez à jour les réponses d'évaluation d'une automatisation à partir d'un fichier — le même document automations schema get <automation-id> écrit.

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongValeur (Value)RequisDescription
--file <json-file>Chemin d'accèsouiJSON avec les user_inputs réponses à appliquer.
Exemple​
uip ah automations update 20 --file ./20.json
uip ah automations update 20 --file ./20.json
Format des données (--sortie json)​
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

flux d'idées uip ah​

Découvrez les flux d'idées configurés et les paires de phase/statut qu'ils autorisent.

liste des flux d'idées uip ah​

Options​
LongDescription
--limit <n> / --offset <n>Pagination appliquée côté client (point de terminaison non paginé).
--all-fieldsRenvoyez la charge utile brute.
Exemple​
uip ah idea-flows list
uip ah idea-flows list
Format des données (--sortie json)​
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}

Phases réduit la forme d'une colonne par phase de la réponse brute (IDEA, ASSESSMENT, QUALIFICATION, ANALYSIS, SOLUTION_DESIGN, DEVELOPMENT, TESTING, TECHNICAL_REVIEW, LIVE) }) dans un seul objet, en incluant uniquement les phases que le flux utilise réellement.

cas métier uip ah​

Lire l'analyse coûts-avantages d'une automatisation (le terme d'Automation Hub est CBA) et définir la base de référence de son plan de projet.

uip ah des cas métier - obtenir​

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongDescription
--all-fieldsRenvoyez la charge utile brute.
Exemple​
uip ah business-cases get 20
uip ah business-cases get 20
Format des données (--sortie json)​
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }

uip ah des cas métier set-baseline​

Verrouillez la base de référence du plan de projet pour une automatisation à partir d'un fichier de dates de phase. Bascule BaselineIsSet sur 1.

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongValeur (Value)RequisDescription
--file <json-file>Chemin d'accèsoui{ "phases": [{ "phase": "Analysis", "start_date": "09/01/2026", "end_date": "09/15/2026" }] }. Les noms de phase proviennent de la section Base de référence de business-cases get (Analyse, Conception de solution, Développement, Test, Date de lancement); les dates sont MM/DD/YYYY; chaque phase, à l'exception de la Date de lancement, nécessite une end_date.

Un tableau de phases bare est encapsulé automatiquement dans { "phases": [...] }; tout ce qui n'est pas déjà { "phases": [...] } est rejeté côté client avant l'envoi de la requête.

Exemple​
uip ah business-cases set-baseline 20 --file ./baseline.json
uip ah business-cases set-baseline 20 --file ./baseline.json
Format des données (--sortie json)​
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

phases uip ah​

Déplacez une automatisation dans le pipeline.

ensemble de phases uip ah​

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongValeur (Value)Description
--phase <variable>stringVariable de phase cible, par exemple TECHNICAL_REVIEW. Préféré par rapport au formulaire hérité; associer avec --status.
--status <variable>stringVariable de statut cible, par exemple AWAITING_REVIEW. Requis avec --phase.
--phase-status-id <id>IntegerID de statut de phase numérique hérité — alternative à --phase/--status, non modifiable avec eux.
--submitter-id <id>IntegerID utilisateur de l'auteur. S'applique uniquement avec --phase-status-id; rejeté avec --phase/--status.

Un seul style est requis: --phase avec --status, ou --phase-status-id seul. Trouvez des paires de phase/statut valides avec uip ah idea-flows list.

Exemples​
uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW
uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW
uip ah phases set 20 --phase-status-id 118
uip ah phases set 20 --phase-status-id 118
Format des données (--sortie json)​
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

Avec --phase-status-id, Data porte PhaseStatusId au lieu de Phase/Status.

questionnaires uip ah​

Lisez le catalogue de questions d'évaluation.

liste de questionnaires uip ah​

Options​
LongValeur (Value)RequisDescription
--assessment <name>high-level|detailed|citizen-developmentouiÉvaluation à lire.
--section <key>stringnonSeule cette section, par ex. q1-overview.
--active-only / --no-active-onlyDrapeaunonSeules les questions actives (la valeur par défaut du serveur)/incluent également les questions inactives.
--mandatory-onlyDrapeaunonUniquement des questions obligatoires.
--limit <n> / --offset <n>IntegernonPagination appliquée côté client (point de terminaison non paginé).
--all-fieldsDrapeaunonRenvoyez la charge utile brute.
Exemple​
uip ah questionnaires list --assessment high-level
uip ah questionnaires list --assessment high-level
Format des données (--sortie json)​
{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}
{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}

pipelines uip ah​

Lire l'ensemble des automatisations — les automatisations avec leurs phases et leurs avantages. Conservé distinct de automations list: le point de terminaison ajoute des colonnes d'avantages par phase et épingle son sens de tri order en interne (même indicateur --sort-order).

liste des pipelines uip ah​

Options​
LongValeur (Value)Description
--search <text>stringRecherche en texte libre.
--sort-by <field>stringChamp à utiliser pour le tri.
--sort-order <direction>asc|descChoisir l'ordre de tri.
--category-id <id...>RépétableUniquement ces catégories.
--application-id <id...>RépétableUniquement les automatisations utilisant ces applications.
--business-unit <name> / --department <name>stringFiltres d'étendue.
--phase-id <id...> / --status-id <id...>RépétableUniquement ces phases/statuts de phase.
--tags <tag...>RépétableUniquement les automatisations qui comportent ces balises.
--priority <priority...>RépétableUniquement ces priorités.
--submission-type <type>stringUniquement ce type de soumission.
--plain-textDrapeauConvertissez les champs de texte enrichi en texte brut.
--limit <n> / --offset <n>IntegerPagination. Par défaut --limit 20.
--all-fieldsDrapeauRenvoyez la charge utile brute.
Exemple​
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
Format des données (--sortie json)​
{
  "Code": "AhPipelinesList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Phase": "Analysis", "PhaseStatus": "In Progress",
      "PhaseOrder": 3, "Priority": 1, "AutomationScore": 78, "EstimatedBenefitFtes": 1.5,
      "EstimatedBenefitPerYear": 42000, "EaseOfImplementation": "Medium",
      "BusinessUnit": "EMEA", "Department": "Finance", "UpdatedEpoch": 1738368000000
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}
{
  "Code": "AhPipelinesList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Phase": "Analysis", "PhaseStatus": "In Progress",
      "PhaseOrder": 3, "Priority": 1, "AutomationScore": 78, "EstimatedBenefitFtes": 1.5,
      "EstimatedBenefitPerYear": 42000, "EaseOfImplementation": "Medium",
      "BusinessUnit": "EMEA", "Department": "Finance", "UpdatedEpoch": 1738368000000
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

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