tâches UIP

Commandes de gestion des tâches, des catalogues, des commentaires, des métadonnées et des données de tâche d’Action Center à l’aide de l’outil « uip tasks ».

uip tasks gère les tâches d’Action Center — les éléments de travail d'intervention humaine (remplissages de formulaires, approbations, validation/classification des documents, labellisation des données) que les processus et les agents RPA créent pour qu’une personne s’exécute. L’outil vous permet de répertorier et d’inspecter les tâches, de les affecter ou de les réaffecter, de les terminer avec une charge utile d’action et de données et de gérer les ressources auxiliaires associées à une tâche: catalogues (configuration du regroupement/de la rétention), commentaires, libellés (balises), métadonnées ( lien titre/Priorité/Catalogue), et les propres données métier/formulaires de la tâche. tasks est le préfixe de la commande; le package sous-jacent est @uipath/tasks-tool.

Concepts

• Étendue des dossiers - chaque verbe qui fonctionne sur une tâche ou un catalogue spécifique accepte --folder-id <id>, --folder-path <path> ou --folder-key <key> (sont mutuellement exclusifs; appliqués au moment de l’analyse via les conflits du Commandant). Lorsqu'aucun n'est transmis sur un terminal interactif, la CLI affiche un sélecteur de dossier; dans une exécution non interactive (CI, agents de codage), il échoue rapidement en demandant un. uip tasks list et uip tasks get sont les deux exceptions. Un dossier y est facultatif et réduit simplement les résultats/la recherche lorsqu’il est indiqué.
• Type de tâche — plusieurs verbes (get --task-type, complete --type) prennent l'un de FormTask, ExternalTask, AppTask, DocumentValidationTask, DocumentClassificationTask, DataLabelingTask, QuickFormTask. Une valeur non reconnue échoue côté client avec la liste complète nommée dans l’erreur.
• Pagination — verbes de style liste (list, catalogs list, comments list, users) page en interne avec une taille de page de 100 éléments et suivez nextCursor jusqu'à ce que cette limite soit épuisée ou --limit , en renvoyant un tableau plate dans l’autre cas, il n’y a pas d’indicateur de curseur à gérer vous-même.
• Les catalogues sont des configurations facultatives de regroupement/rétention pour les tâches — metadata --catalog-id lie une tâche à une tâche; Les champs de rétention de catalogs create/update (--retention-action, --retention-period, --retention-bucket-id) contrôlent ce qu'il advient des données de catalogue au fil du temps. L'expression --encrypted sur catalogs create est immuable - il n'y a aucun moyen de la modifier via catalogs update.

Synthèse

uip tasks list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [--as-admin] [-l, --limit <n>]
uip tasks get <id> [--task-type <type>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks assign <task-id> (--user-id <id> | --user <email>)
uip tasks reassign <task-id> (--user-id <id> | --user <email>)
uip tasks unassign <task-id>
uip tasks complete <task-id> --type <type> [--data <json>] [--action <action>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks users [folder-id] [--folder-path <path> | --folder-key <key>] [-l, --limit <n>]

uip tasks catalogs list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [-l, --limit <n>]
uip tasks catalogs get <id> [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs create --name <name> [--description <text>] [--encrypted] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs update <id> [--name <name>] [--description <text>] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]

uip tasks comments list <task-id> [-l, --limit <n>] [folder options]
uip tasks comments add <task-id> --text <text> [folder options]

uip tasks labels <task-id> --labels <json> [folder options]
uip tasks metadata <task-id> [--title <text>] [--priority <level>] [--catalog-id <id> | --unset-catalog] [--note <text>] [folder options]

uip tasks data get <task-id> [folder options]
uip tasks data save <task-id> --data <json> [folder options]

liste des tâches UiP

Lister les tâches dans plusieurs dossiers (ou un seul dossier, lorsqu'ils sont étendus).

Options

Long	Valeur (Value)	Description
--folder-id <id>	Integer	Filtrez par ID de dossier.
--folder-path <path>	string	Filtrez par chemin de dossier (alternative à --folder-id).
--folder-key <key>	GUID	Filtrer par clé de dossier (alternative à --folder-id).
--as-admin	Drapeau	Répertorier les tâches en tant qu’administrateur (visible plus large que vos propres tâches affectées/disponibles).
-l, --limit <number>	Integer	Nombre maximal d'éléments à renvoyer. Récupère tout (pagination en interne) lorsqu'il est omis.

Exemple

uip tasks list --folder-path "Shared/Finance" --limit 20

Format des données (--sortie json)

{ "Code": "TaskList", "Data": [ { "id": 1, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } ] }

tâches UiP - Obtenir

Obtenir les détails d’une tâche par ID.

Arguments

Nom	Requis	Objectif
<id>	oui	ID de tâche. Utilisez tasks list pour en trouver un.

Options

Long	Valeur (Value)	Description
--task-type <type>	l’un des 7 types de tâches	Type de tâche. Nécessite une option de dossier lorsqu'elle est validée ; dans le cas contraire, elle échoue rapidement.
--folder-id <id> / --folder-path <path> / --folder-key <key>		Étendue du dossier. Obligatoire uniquement lorsque --task-type est défini.

Exemple

uip tasks get 123 --task-type FormTask --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskDetails", "Data": { "id": 123, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } }

tâches uip affecter/réaffecter

Attribuez une tâche à un utilisateur ou réaffectez-la à un autre — forme d'option identique, différente Code en cas de réussite.

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Requis	Description
--user-id <id>	Integer	l'un de ces deux	ID utilisateur numérique du bénéficiaire.
--user <email>	string	l'un de ces deux	Le nom d’utilisateur ou l’e-mail du bénéficiaire (alternatif à --user-id).

La transmission n’échoue pas avec un message explicite « bénéficiaire manquant »; Erreur.

Exemple

uip tasks assign 123 --user [e-mail]
uip tasks reassign 123 --user-id 7

Format des données (--sortie json)

{ "Code": "TaskAssigned", "Data": { "id": 123, "assignedTo": "[e-mail]" } }

Code est TaskReassigned pour reassign.

annulation de l’affectation de tâches UiP

Supprimer le bénéficiaire d'une tâche. Aucune option au-delà de l'ID de tâche.

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Exemple

uip tasks unassign 123

Format des données (--sortie json)

{ "Code": "TaskUnassigned", "Data": { "id": 123 } }

tâches uip terminées

Terminez une tâche avec une action et une charge utile de données facultative.

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Requis	Description
--type <type>	l’un des 7 types de tâches	oui	Type de tâche — validé côté client par rapport à l'enum.
--data <json>	JSON	non	Charge utile des données de tâche sous la forme d’une chaîne JSON.
--action <action>	string	Conditionnel	Nom de l'action. Obligatoire dans la pratique pour FormTask et AppTask (non appliqué côté client — la plateforme rejette une action manquante pour ces types).
Options de dossier		non	Un dossier est résolu (de manière interactive s'il est omis, sur un TType) avant de s'achever.

Exemple

uip tasks complete 123 --type FormTask --action Approve --data '{"comment":"Looks good"}'

Format des données (--sortie json)

{ "Code": "TaskCompleted", "Data": { "id": 123, "status": "Completed" } }

utilisateurs de tâches UIP

Répertorier les utilisateurs disposant d'autorisations de tâches dans un dossier - la source des valeurs --user-id/--user sur assign/reassign.

Arguments

Nom	Requis	Objectif
[folder-id]	non	L'ID de dossier en tant qu'argument de position. mutuellement exclusif avec --folder-path/--folder-key — la transmission des deux échoue explicitement.

Options

Long	Valeur (Value)	Description
--folder-path <path>	string	Chemin d'accès au dossier (alternative à l'argument de position).
--folder-key <key>	GUID	Clé de dossier (alternative à l'argument de position).
-l, --limit <number>	Integer	Nombre maximal d'éléments à renvoyer.

Exemple

uip tasks users 42
uip tasks users --folder-path "Shared/Finance" --limit 10

Format des données (--sortie json)

{
  "Code": "TaskUserList",
  "Data": [
    { "id": 1, "name": "Alice", "surname": "Smith", "userName": "alice", "emailAddress": "[e-mail]", "displayName": "Alice Smith" }
  ]
}

Catalogues de tâches UiP

Gérer les catalogues de tâches: regroupements de tâches nommés avec une politique de chiffrement et de rétention facultative.

Liste des catalogues de tâches UIP

Options

Long	Valeur (Value)	Description
Options de dossier		Dossier dans lequel répertorier les catalogues (un dossier est résolu s'il est omis, par Concepts).
-l, --limit <number>	Integer	Nombre maximal d'éléments à renvoyer.

Exemple

uip tasks catalogs list --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCatalogList", "Data": [ { "id": 5, "name": "Invoices", "encrypted": false } ] }

Catalogues de tâches uip - Obtenir

Arguments

Nom	Requis	Objectif
<id>	oui	ID du catalogue de tâches.

Exemple

uip tasks catalogs get 5 --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCatalogDetails", "Data": { "id": 5, "name": "Invoices", "encrypted": false } }

Création de catalogues de tâches uip

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom du catalogue.
--description <text>	string	non	Description du catalogue.
--encrypted	Drapeau	non	Chiffrez les données des tâches dans ce catalogue. Immuable — ne peut pas être modifié par catalogs update ultérieurement.
--retention-action <action>	Delete | Archive	non	Que se passe-t-il à la limite de rétention. Toute autre valeur échoue côté client.
--retention-period <days>	Integer	non	Période de rétention en jours.
--retention-bucket-id <id>	Integer	non	ID de compartiment de stockage, utilisé lorsque --retention-action Archive.

Exemple

uip tasks catalogs create --name Invoices --retention-action Archive --retention-period 90 --retention-bucket-id 3 --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCatalogCreated", "Data": { "id": 5, "name": "Invoices" } }

Mise à jour des catalogues de tâches uip

Fusionner: seuls les indicateurs que vous transmettez changent. Au moins une des --name/--description/--retention-action/--retention-period/--retention-bucket-id est requise; l'appel avec aucun n'échoue avant un accès au fichier/réseau. --encrypted ne peut pas être modifié ici.

Arguments

Nom	Requis	Objectif
<id>	oui	ID du catalogue de tâches.

Options

Même ensemble que create moins --encrypted.

Exemple

uip tasks catalogs update 5 --name "Invoices v2" --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCatalogUpdated", "Data": { "id": 5, "name": "Invoices v2" } }

commentaires sur les tâches UIP

liste de commentaires des tâches UIP

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Description
-l, --limit <number>	Integer	Nombre maximal d'éléments à renvoyer.
Options de dossier		Dossier dans lequel se trouve la tâche.

Exemple

uip tasks comments list 123 --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCommentList", "Data": [ { "id": 1, "text": "Looks good", "createdBy": "alice" } ] }

tâches de l’interface utilisateur - Ajouter des commentaires

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Requis	Description
--text <text>	string	oui	Texte de commentaire. Les chaînes vides sont rejetées.
Options de dossier		non	Dossier dans lequel se trouve la tâche.

Exemple

uip tasks comments add 123 --text "Escalating to finance" --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskCommentCreated", "Data": { "id": 2, "text": "Escalating to finance" } }

libellés des tâches UIP

Définissez ou supprimez les libellés d’une tâche en un seul appel — il s’agit d’un remplacement complet, et non d’une fusion; saisissez chaque libellé que vous souhaitez conserver.

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Requis	Description
--labels <json>	Tableau JSON	oui	Libellés à définir, par exemple [{"name":"region","displayName":"Region","displayValue":"EMEA"}]. Transmettez [] pour effacer tous les libellés. Doit être un tableau JSON — une valeur hors tableau échoue côté client.
Options de dossier		non	Dossier dans lequel se trouve la tâche.

Exemple

uip tasks labels 123 --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskLabelsSaved", "Data": { "taskId": 123, "labels": [{ "name": "region", "displayName": "Region", "displayValue": "EMEA" }] } }

métadonnées des tâches UIP

Modifiez le titre, la priorité, le lien du catalogue et enregistrez une note avec la modification. Fusionner: seuls les indicateurs que vous transmettez changent; au moins un est requis.

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Description
--title <title>	string	Nouveau titre.
--priority <priority>	Low | Medium | High | Critical	Nouvelle priorité. Une valeur non définie échoue côté client en attribuant le nom de l'ensemble valide.
--catalog-id <id>	Integer	Associez un catalogue des tâches. Capture mutuellement exclusive avec --unset-catalog.
--unset-catalog	Drapeau	Supprimez l'association du catalogue de la tâche. Capture mutuellement exclusive avec --catalog-id.
--note <text>	string	Commentaire enregistré avec la modification.

Exemple

uip tasks metadata 123 --priority High --note "Escalated per manager request" --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskMetadataEdited", "Data": { "taskId": 123 } }

données des tâches UIP

Lisez ou écrivez le formulaire/objet de données métier sous-jacent d'une tâche.

Obtenir des données des tâches UIP

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Exemple

uip tasks data get 123 --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskData", "Data": { "invoiceNumber": "INV-001", "amount": 250.0 } }

Enregistrer les données des tâches UIP

Arguments

Nom	Requis	Objectif
<task-id>	oui	ID de tâche.

Options

Long	Valeur (Value)	Requis	Description
--data <json>	Object JSON	oui	Données de tâche à enregistrer. Doit être un objet JSON (pas un tableau ou un scalaire) — tout le reste échoue côté client.

Exemple

uip tasks data save 123 --data '{"invoiceNumber":"INV-001","amount":250.0}' --folder-id 42

Format des données (--sortie json)

{ "Code": "TaskDataSaved", "Data": { "taskId": 123 } }

Voir également

• Concepts: comment UiPath CLI est organisé — où les outils s’intègrent dans le modèle hôte + outil.
• Sessions — la façon dont le contexte du locataire est résolu.
• uip or folders — recherchez les ID/chemins/clés de dossier pour les options d'étendue de dossier sur cette page.
• uip login — session utilisée pour tous les appels d'Action Center.
• Options globales
• Codes de sortie