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.

applications uip ah, composants, documents, médias, listes de magasins, avis en magasin

Syntaxe et options pour l'inventaire des applications Automation Hub, les composants réutilisables, les documents/documents joints et le Marketplace Automation Store (listes et avis publiés).

L’ inventaire des applications est ce sur quoi les automatisations sont balisées (les filtres --application-id le référencent ailleurs). Les composants sont des blocs de construction réutilisables, éventuellement liés à une automatisation. Les documents et les supports sont des fichiers joints à une automatisation — un PDD, une capture d'écran, une vidéo de démonstration. Le Automation Store est le Marketplace interne d'Automation Hub: les listes de magasins sont des automatisations publiées, les avis sur le magasin sont les avis qui y sont laissés. Voir uip ah pour les concepts partagés (projection/--all-fields, listes pages par rapport aux listes non pages) qui s'appliquent à chaque verbe ici.

applications uip ah​

Gérer l’inventaire des applications avec lequel les automatisations sont balisées.

Synthèse​

uip ah applications list [--search <text>] [--category-id <id...>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah applications update --file <json-file>
uip ah applications delete <application-id> [-y, --yes]
uip ah applications list [--search <text>] [--category-id <id...>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah applications update --file <json-file>
uip ah applications delete <application-id> [-y, --yes]

liste des applications uip ah​

Options​
LongValeur (Value)Description
--search <text>stringRecherche en texte libre.
--category-id <id...>RépétableUniquement les applications de ces catégories.
--limit <n> / --offset <n>IntegerPagination. Par défaut --limit 20.
--all-fieldsDrapeauRenvoyez la charge utile brute.
Exemple​
uip ah applications list
uip ah applications list
Format des données (--sortie json)​
{
  "Code": "AhApplicationsList",
  "Data": [
    { "Id": 1, "Name": "SAP", "Version": "S/4HANA", "Language": null, "Code": "SAP", "IsActive": 1, "AddedByEndUser": 0, "CategoryIds": [4], "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}
{
  "Code": "AhApplicationsList",
  "Data": [
    { "Id": 1, "Name": "SAP", "Version": "S/4HANA", "Language": null, "Code": "SAP", "IsActive": 1, "AddedByEndUser": 0, "CategoryIds": [4], "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

mise à jour des applications uip ah​

Mettez à jour les applications existantes dans l’inventaire à partir d’un fichier. Cela modifie les entrées qui existent déjà — il ne peut pas en ajouter une, car le service requiert une application_id sur chaque élément.

Options​
LongValeur (Value)RequisDescription
--file <json-file>Chemin d'accèsouiTableau JSON des applications à mettre à jour. Chaque élément a besoin de application_id et categoryIds — prendre la forme de applications list --all-fields.
Exemple​
uip ah applications update --file ./applications.json
uip ah applications update --file ./applications.json
Format des données (--sortie json)​
{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }
{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }

suppression d'applications uip ah​

Arguments​
NomRequisObjectif
<application-id>ouiID d'application.
Options​
LongDescription
-y, --yesConfirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.
Exemple​
uip ah applications delete 7 --yes
uip ah applications delete 7 --yes
Format des données (--sortie json)​
{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }
{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }

composants uip ah​

Lisez les composants réutilisables, à l’échelle du locataire ou par automatisation. En lecture seule — il n’y a pas de création/mise à jour/suppression sur cette surface.

liste des composants uip ah​

Options​
LongValeur (Value)Description
--automation-id <id>IntegerÉtendue aux composants associés à cette automatisation — un point de terminaison distinct qui ne prend pas d'autres filtres.
--type <type>stringUniquement ce type de composant. Impossible de combiner avec --automation-id.
--category-id <id...>RépétableUniquement ces catégories. Impossible de combiner avec --automation-id.
--application-id <id...>RépétableUniquement les composants utilisant ces applications. Impossible de combiner avec --automation-id.
--limit <n> / --offset <n>IntegerPagination. Par défaut --limit 20.
--all-fieldsDrapeauRenvoyez la charge utile brute.

--type/--category-id/--application-id combiné avec --automation-id échoue côté client — la liste par automatisation est un point de terminaison différent qui ne prend aucun filtre.

Exemples​
uip ah components list
uip ah components list
uip ah components list --automation-id 20
uip ah components list --automation-id 20
Format des données (--sortie json)​
{
  "Code": "AhComponentsList",
  "Data": [
    { "Id": 3, "Name": "Invoice parser", "Slug": "invoice-parser", "Description": "...", "TypeId": 1, "ReviewCount": 4, "ReviewAverage": 4.5, "DownloadCount": 12, "StatusId": 1, "PhaseId": 3, "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}
{
  "Code": "AhComponentsList",
  "Data": [
    { "Id": 3, "Name": "Invoice parser", "Slug": "invoice-parser", "Description": "...", "TypeId": 1, "ReviewCount": 4, "ReviewAverage": 4.5, "DownloadCount": 12, "StatusId": 1, "PhaseId": 3, "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

documents uip ah​

Gérez les documents joints à une automatisation.

liste des documents uip ah​

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongDescription
--limit <n> / --offset <n>Pagination. Par défaut --limit 20.
--all-fieldsRenvoyez la charge utile brute.
Exemple​
uip ah documents list 20
uip ah documents list 20
Format des données (--sortie json)​
{
  "Code": "AhDocumentsList",
  "Data": [
    { "Id": 11, "AutomationId": 20, "Title": "PDD", "Description": "...", "TypeId": 1, "FileId": 42, "FileType": "docx", "EmbedLink": null, "IsActive": 1, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}
{
  "Code": "AhDocumentsList",
  "Data": [
    { "Id": 11, "AutomationId": 20, "Title": "PDD", "Description": "...", "TypeId": 1, "FileId": 42, "FileType": "docx", "EmbedLink": null, "IsActive": 1, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

FileId est ce que prend documents download.

création de documents uip ah​

Joignez un document à une automatisation - téléchargez les octets du fichier avec --file, ou liez-y avec --embed-link (exactement l'un des deux).

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongValeur (Value)RequisDescription
--title <text>stringouiTitre du document.
--description <text>stringouiDescription du document.
--document-type-id <id>IntegerouiID du type de document.
--file <path>Chemin d'accèsConditionnelFichier document local à télécharger. L’un des --file/--embed-link est requis. Aucune liste d’autorisation de type MIME côté serveur — les extensions non reconnues sont téléchargées en tant que application/octet-stream.
--embed-link <url>urlConditionnelLier à un document déjà hébergé. L’un des --file/--embed-link est requis.
--submitter <email>E-mailnonE-mail de l'utilisateur d'Automation Hub soumettant. La valeur par défaut de l'appelant.
Exemples​
uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --file ./pdd.docx
uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --file ./pdd.docx
uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --embed-link https://acme.sharepoint.com/pdd.docx
uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --embed-link https://acme.sharepoint.com/pdd.docx
Format des données (--sortie json)​
{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }
{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }

Avec --embed-link, Data porte EmbedLink au lieu de FileId/File.

Téléchargement de documents uip ah​

Arguments​
NomRequisObjectif
<file-id>ouiID de fichier — le FileId de documents list <automation-id>.
Options​
LongValeur (Value)RequisDescription
--destination <path>Chemin d'accèsouiChemin local dans lequel écrire le fichier.
Exemple​
uip ah documents download 42 --destination ./pdd.pdf
uip ah documents download 42 --destination ./pdd.pdf
Format des données (--sortie json)​
{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }
{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }

média uip ah​

Joindre un média (capture d'écran, vidéo) à une automatisation. Séparez de documents — son propre point de terminaison de téléchargement, et il n'y a pas de liste ni de suppression.

Création de média uip ah​

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l’automatisation.
Options​
LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier multimédia local à télécharger - jpg, jpeg, png, gif ou mp4 uniquement; toute autre extension est rejetée côté client.
--submitter <email>E-mailnonE-mail de l'utilisateur d'Automation Hub soumettant. La valeur par défaut de l'appelant.
Exemple​
uip ah media create 20 --file ./screen.png
uip ah media create 20 --file ./screen.png
Format des données (--sortie json)​
{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }
{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }

uip ah Store-lists​

Lisez les automatisations publiées dans l'Automation Store. En lecture seule.

liste-listes de magasins uip ah​

Options​
LongValeur (Value)Description
--search <text>stringRecherche en texte libre.
--category-id <id...>RépétableUniquement ces catégories.
--application-id <id...>RépétableUniquement les listes utilisant ces applications.
--business-unit <name>stringUniquement cette unité commerciale.
--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 store-listings list
uip ah store-listings list
Format des données (--sortie json)​
{
  "Code": "AhStoreListingsList",
  "Data": [
    { "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "ReviewCount": 4, "ReviewScore": 4.2, "DownloadCount": 4, "VoteCount": 9, "IsPublished": 1, "BusinessUnit": "EMEA", "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}
{
  "Code": "AhStoreListingsList",
  "Data": [
    { "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "ReviewCount": 4, "ReviewScore": 4.2, "DownloadCount": 4, "VoteCount": 9, "IsPublished": 1, "BusinessUnit": "EMEA", "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

avis-store uip ah​

Lisez les avis de l'Automation Store sur une automatisation. Son propre groupe de ressources plutôt qu'un verbe sous store-listings. En lecture seule.

liste des avis sur le magasin uip ah​

Arguments​
NomRequisObjectif
<automation-id>ouiIdentifiant de l'automatisation — doit être publié dans le magasin.
Options​
LongDescription
--limit <n> / --offset <n>Pagination. Par défaut --limit 20.
--all-fieldsRenvoyez la charge utile brute.
Exemple​
uip ah store-reviews list 20
uip ah store-reviews list 20
Format des données (--sortie json)​
{
  "Code": "AhStoreReviewsList",
  "Data": [
    { "Id": 5, "AutomationId": 20, "Score": 5, "Title": "Great automation", "Description": "...", "UserId": 3, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}
{
  "Code": "AhStoreReviewsList",
  "Data": [
    { "Id": 5, "AutomationId": 20, "Score": 5, "Title": "Great automation", "Description": "...", "UserId": 3, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "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