uip est des ressources

Syntaxe et options de `uip is resource`, qui répertorie, décrit et exécute les opérations sur les objets du plan de données du connecteur.

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 run appelle le plan de données du connecteur (Créer/Répertorier/Obtenir/Mettre à jour/Remplacer/Supprimer) en regard d'une connexion. Chaque run 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.

Important :

Le groupe de verbes du plan de données est uip is resources run, non execute — uip is resources execute ... n'existe pas et échoue avec une « commande inconnue».

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.
run	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).
—	--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 — le objectName du fichier JSON de la configuration de l'activité (par exemple, tickets). Recherchez des noms avec resources list. Adresse l'objet de la même manière sous les deux valeurs --activity-version (voir ci-dessous).

Options

Short	Long	Valeur (Value)	Default	Description
—	--connection-id	id	—	Étendue à une connexion (active les champs personnalisés; requis avec --field).
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete, ou Replace. Requis avec --field.
—	--activity-version	1.0.0 | 4.0.0	1.0.0	Quels points de terminaison des métadonnées d'activité interroger — voir Versions de métadonnées d'activité ci-dessous.
-f	--field	name=value	—	Valeur du champ parent. Répétable. Exécute le type d'API ObjectAction du connecteur (par exemple, GenerateSchema de Jira, GenerateQuerySchema de Salesforce) et fusionne sa réponse de champ personnalisé dans requestFields. Nécessite à la fois --connection-id et --operation. Non pris en charge avec --activity-version 4.0.0.
—	--action	name	déduit	Nom ObjectAction de type d'API explicite (par exemple GenerateSchema). Facultatif — déduit des noms --field lorsqu'ils sont omis; transmettez-le pour désambiguer lorsque plusieurs actions peuvent correspondre.
—	--refresh	Drapeau	désactivé	Forcer la réextraction à partir de l’API, en ignorant le cache. Le cache est également automatiquement ignoré chaque fois que --field est fourni, car la réponse conception-action varie par combinaison parent-champ.

Versions des métadonnées d’activité

--activity-version bascule le point de terminaison describe des métadonnées Integration Service:

• 1.0.0 (par défaut) — Points de terminaison des éléments v3, étendue de la connexion. Prend en charge -f/--field recherches de conception-action.
• 4.0.0 — points de terminaison des éléments v4, pas au niveau de la connexion. La transmission de --connection-id est acceptée, mais ignorée (avec un avertissement), car la version v4 n'en a pas besoin pour l'extraction elle-même. -f/--field est rejeté définitivement avec --activity-version 4.0.0 — les ObjectActions de conception sont une fonctionnalité spécifique à la version v3 uniquement et à l'échelle de l'instance.

Dans les deux cas, la position <object-name> signifie la même chose - le nom de l'objet - il n'y a donc pas de différence d'adressage entre les deux versions, uniquement le point de terminaison backend qui répond à l'appel.

Exemples

# List operations available on this object (v3, default)
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'

# Describe a 4.0.0 activity by object name (v4 elements endpoints)
uip is resources describe uipath-salesforce-slack add_users_to_usergroup \
    --activity-version 4.0.0

# Parent-field values (Jira: project + issue type → custom fields for that combination)
uip is resources describe uipath-atlassian-jira curated_create_issue \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f fields.project.key=ENGCE -f fields.issuetype.id=3

# Body-token parent field (Salesforce SOQL: query → response columns)
uip is resources describe uipath-salesforce-sfdc query_records \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f query="SELECT Id, Name FROM Account WHERE Status = 'Active'"

Remarque :

Si un appel -f/--field revient en conservant uniquement les champs que vous avez fournis (aucun des champs personnalisés de la connexion), la réponse comporte également une Warning: l'une des valeurs que vous avez transmises n'existe probablement pas sur cette connexion. Vérifiez-le par rapport à la recherche de ce champ.

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.

Avec -f/--field (recherche du champ parent/action de conception), requestFields reflète le schéma fusionné spécifique à la connexion:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "curated_create_issue",
    "operation": { "method": "POST", "name": "Create" },
    "requestFields": [
      { "name": "fields.project.key", "required": true, "displayName": "Project" },
      { "name": "fields.issuetype.id", "required": true, "displayName": "Issue type" },
      { "name": "fields.summary", "required": true, "displayName": "Summary" },
      { "name": "fields.description", "required": false, "displayName": "Description" }
    ]
  }
}

uip est une exécution de ressources

Appelez le plan de données du connecteur. run 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. delete est irréversible et nécessite -y, --yes — la CLI ne s'invite jamais.

uip is resources run create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run list     <connector-key> <object-name> --connection-id <id>
uip is resources run get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--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.
—	--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.
-y	--yes	Drapeau	—	Requis sur delete uniquement. Confirme cette opération irréversible — la CLI ne s'affiche jamais.

Exemples

# Create a ticket
uip is resources run 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 run list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID — destructive, requires --yes
uip is resources run delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001' \
    --yes

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