uip est des ressources

uip is resources fonctionne avec les objets de runtime qu'adresse un connecteur - tickets, contacts, enregistrements, fichiers. list énumère les objets du connecteur, describe renvoie le schéma de champ et les opérations d'un objet, et execute appelle le plan de données du connecteur (Créer/Répertorier/Obtenir/Mettre à jour/Remplacer/Supprimer) en regard d'une connexion. Chaque execute verbe requiert --connection-id; les lectures de métadonnées mises en cache (list, describe) l’acceptent éventuellement pour faire apparaître des objets/champs personnalisés.

Synthèse

uip is resources <verb> [options]

Verbes

Verbe	Objectif
list	Répertorier les objets disponibles sur un connecteur; éventuellement filtrer par opération.
describe	Décrivez les opérations d’un objet et le schéma de champ.
execute	Appelez le plan de données du connecteur (Créer/Liste/Obtenir/Mettre à jour/Remplacer/Supprimer).

uip est une liste de ressources

Répertoriez les objets disponibles sur un connecteur. Les résultats dépendent du fait que --connection-id est fourni — les listes à l'échelle de la connexion incluent des objets personnalisés; les listes sans étendue ne le sont pas (la CLI affiche une Warning dans ce cas).

Arguments

Nom	Requis	Objectif
<connector-key>	oui	Clé du connecteur, par exemple uipath-zoho-desk.

Options

Short	Long	Valeur (Value)	Default	Description
—	--operation	ENUM	—	Filtrer par opération: List, Retrieve, Create, Update, Delete, Replace.
—	--connection-id	id	—	Étendue à une connexion spécifique (active les objets personnalisés).
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--refresh	Drapeau	désactivé	Forcer la réextraction à partir de l’API, en ignorant le cache.

Exemples

uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

Format des données (--sortie json)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}

uip est une description des ressources

Décrivez les champs et les opérations d'un objet. Sans --operation, renvoie la liste des opérations disponibles et une suggestion. Avec --operation, se réduit à une seule opération et renvoie ses paramètres, champs de requête et champs de réponse.

Arguments

Nom	Requis	Objectif
<connector-key>	oui	Clé du connecteur.
<object-name>	oui	Nom de l'objet (par exemple, tickets). Recherchez des noms avec resources list.

Options

Short	Long	Valeur (Value)	Default	Description
—	--connection-id	id	—	Étendue à une connexion (active les champs personnalisés).
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete, ou Replace
—	--refresh	Drapeau	désactivé	Forcer la réextraction à partir de l’API, en ignorant le cache.

Exemples

# List operations available on this object
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'Data.requestFields[?required].name'

Format des données (--sortie json)

Sans --operation:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}

Avec --operation Create, le même Code: "ResourceMetadata" est renvoyé, mais au lieu de availableOperations la charge utile porte operation, parameters, requestFields et responseFields.

uip est l'exécution des ressources

Appelez le plan de données du connecteur. execute est lui-même un groupe; les verbes réels sont create, list, get, update, replace et delete. Chaque verbe nécessite --connection-id; create, update et replace nécessitent en outre --body avec un corps de requête JSON.

uip is resources execute create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute list     <connector-key> <object-name> --connection-id <id>
uip is resources execute get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources execute update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute delete   <connector-key> <object-name> --connection-id <id> [--query <params>]

Mappage de la méthode HTTP: create → POST, list → GET (capture), get → GET-by-id, update → PATCH, replace → PUT, delete → DELETE.

Arguments

Nom	Requis	Objectif
<connector-key>	oui	Clé du connecteur.
<object-name>	oui	Nom de l'objet (par exemple, tickets).

Options partagées

Short	Long	Valeur (Value)	Default	Description
—	--connection-id	id	requis	Connexion utilisée pour autoriser l'appel du plan de données.
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--query	Paramètres	—	Paramètres de requête. Accepte key=value&key=value ou un objet JSON.
—	--body	JSON	—	Corps de la demande. Requis pour create, update, replace.

Exemples

# Create a ticket
uip is resources execute create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources execute list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID
uip is resources execute delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001'

Format des données (--sortie json)

{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}

Les opérations list renvoient { "items": [...] } et, lorsque le backend signale plus de pages via les en-têtes Elements-Has-More / Elements-Next-Page-Token , incluez un objet Pagination avec HasMore et NextPageToken

Les appels échoués sont signalés par Failure, le statut HTTP par Message et le corps du serveur par Instructions.

Associé

• uip is connections — Les valeurs --connection-id proviennent de connections list / connections create.
• uip is connectors — découvrez d'abord la clé du connecteur.
• uip is activities — voir les opérations nommées qu'un connecteur expose.
• uip is triggers — équivalents basés sur des événements aux verbes du plan de données ici.

Voir également

• Présentation de l’outil Integration Service
• Options globales
• Codes de sortie