UIP ist Ressourcen

Syntax und Optionen für „uip is resource“, die Vorgänge für Connector-Datenebenenobjekte auflistet, beschreibt und ausführt.

uip is resources funktioniert mit den Runtime-Objekten, die ein Connector adressiert – Tickets, Kontakte, Datensätze, Dateien. list listet die Objekte des Connectors auf, describe gibt das Feldschema und die Vorgänge für ein Objekt zurück und run ruft die Datenebene des Connectors (Create/List/Get/Update/Replace/Delete) für eine Verbindung auf. Jedes run -Verb erfordert --connection-id; Die zwischengespeicherten Metadaten (list, describe) akzeptieren es optional, um benutzerdefinierte Objekte/Felder aufzudecken.

Wichtig:

Die Verbgruppe auf Datenebene ist uip is resources run, nicht execute – uip is resources execute ... ist nicht vorhanden und schlägt mit „unbekannter Befehl“ fehl.

Zusammenfassung

uip is resources <verb> [options]

Verben

Verb	Zweck
list	Listen Sie die für einen Connector verfügbaren Objekte auf; Optional nach Vorgang filtern.
describe	Beschreiben Sie die Vorgänge und das Feldschema eines Objekts.
run	Rufen Sie die Datenebene des Connectors auf (Erstellen/Auflisten/Abrufen/Aktualisieren/Ersetzen/Löschen).

UIP ist eine Ressourcenliste

Listen Sie die für einen Connector verfügbaren Objekte auf. Die Ergebnisse hängen davon ab, ob --connection-id angegeben ist – verbindungsbezogene Auflistungen enthalten benutzerdefinierte Objekte; Auflistungen ohne Scope nicht (die CLI zeigt in diesem Fall ein Warning an).

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel, z. B. uipath-zoho-desk.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--operation	ENUM	–	Nach Vorgang filtern: List, Retrieve, Create, Update, Delete, Replace.
–	--connection-id	id	–	Scope auf eine bestimmte Verbindung (aktiviert benutzerdefinierte Objekte).
–	--refresh	Markieren	aus	Erzwingen Sie den erneuten Abruf über die API und ignorieren Sie den Cache.

Beispiele

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

Datenform (--output json)

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

UIP ist Ressourcenbeschreibung

Beschreiben Sie die Felder und Vorgänge eines Objekts. Ohne --operation wird die Liste der verfügbaren Vorgänge und ein Hinweis zurückgegeben. Mit --operation wird auf einen Vorgang verengt und dessen Parameter, Anforderungsfelder und Antwortfelder zurückgegeben.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.
<object-name>	ja	Objektname – der objectName aus dem Konfigurations-JSON der Aktivität (z. B. tickets). Suchen Sie Namen mit resources list. Beantwortet das Objekt auf die gleiche Weise unter beiden --activity-version -Werten (siehe unten).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--connection-id	id	–	Scope auf eine Verbindung (aktiviert benutzerdefinierte Felder; zusammen mit --field erforderlich).
–	--operation	ENUM	–	List, Retrieve, Create, Update, Delete, oder Replace. Erforderlich zusammen mit --field.
–	--activity-version	1.0.0 | 4.0.0	1.0.0	Welche Aktivitätsmetadaten-Endpunkte abgefragt werden sollen – siehe Aktivitätsmetadatenversionen unten.
-f	--field	name=value	–	Wert des übergeordneten Felds. Wiederholbar. Führt den API-Typ ObjectAction des Connectors (z. B. GenerateSchema von Jira, GenerateQuerySchema von Salesforce) aus und führt seine Antwort auf benutzerdefinierte Felder in requestFields zusammen. Erfordert sowohl --connection-id als auch --operation. Nicht mit --activity-version 4.0.0 unterstützt.
–	--action	name	abgeleitet	Expliziter Name des API-Typs ObjectAction (z. B. GenerateSchema). Optional – abgeleitet von den --field -Namen, wenn sie weggelassen werden; Übergeben Sie sie zur Mehrdeutigkeit, wenn mehr als eine Aktion übereinstimmen kann.
–	--refresh	Markieren	aus	Erzwingen Sie den erneuten Abruf über die API und ignorieren Sie den Cache. Der Cache wird auch automatisch umgangen, wenn --field angegeben wird, da eine Design-Aktions-Antwort je nach übergeordnetem Feld-Kombination variiert.

Aktivitätsmetadatenversionen

--activity-version schaltet um, welche Integration Service-Metadaten-Endpunkte describe abfragen:

• 1.0.0 (Standard) – v3-Elementendpunkte, verbindungsbezogene. Unterstützt -f/--field Design-Aktionssuche.
• 4.0.0 – v4-Elementendpunkte ohne Verbindungs-Scope. Die Übergabe von --connection-id daneben wird akzeptiert, aber ignoriert (mit einer Warnung), da v4 es nicht für den Abruf selbst benötigt. -f/--field wird direkt mit --activity-version 4.0.0 abgelehnt – ObjectActions zur Entwurfszeit sind eine reine v3-Funktion mit Instanz-Scope.

In beiden Fällen bedeutet die Position <object-name> dasselbe – den Namen des Objekts –, sodass es keinen Adressierungsunterschied zwischen den beiden Versionen gibt. Es besteht nur der Back-End-Endpunkt, den der Anruf beantwortet.

Beispiele

# 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'"

Hinweis:

Wenn ein -f/--field -Aufruf nur die von Ihnen angegebenen Felder enthält (keine eigenen benutzerdefinierten Felder der Verbindung), enthält die Antwort auch einen Warning: Einer der übergebenen Werte ist für diese Verbindung wahrscheinlich nicht vorhanden. Vergleichen Sie es mit der Suche für dieses Feld.

Datenform (--output json)

Ohne --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."
  }
}

Mit --operation Create wird dieselbe Code: "ResourceMetadata" zurückgegeben, aber anstelle von availableOperations enthält die Nutzlast operation, parameters, requestFields und responseFields.

Mit -f/--field (Übergeordnetesfeld/Design-Aktionssuche) spiegelt requestFields das zusammengeführte, verbindungsspezifische Schema wider:

{
  "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 ist Ressourcen ausgeführt

Rufen Sie die Datenebene des Connectors auf. run ist selbst eine Gruppe; Die eigentlichen Verben sind create, list, get, update, replace und delete. Jedes Verb erfordert --connection-id; create, update und replace erfordern zusätzlich --body mit einem JSON-Anforderungstext. delete ist destruktiv und erfordert -y, --yes – die CLI fordert nie auf.

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>]

HTTP-Methodenzuordnung: create → POST, list → GET (Sammlung), get → GET-by-id, update → PATCH, replace → PUT, delete → DELETE.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.
<object-name>	ja	Objektname (z. B. tickets).

Freigegebene Optionen

Short	Long	Wert	Standard	Beschreibung
–	--connection-id	id	erforderlich	Verbindung, die zum Autorisieren des Aufrufs der Datenebene verwendet wird.
–	--query	Parameter	–	Abfrageparameter. Akzeptiert key=value&key=value oder ein JSON-Objekt.
–	--body	JSON	–	Anforderungstext. Erforderlich für create, update, replace.
-y	--yes	Markieren	–	Nur bei delete erforderlich. Bestätigt diesen nicht rückgängig zu machenden Vorgang – die CLI fordert Sie nie auf.

Beispiele

# 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

Datenform (--output json)

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

list -Vorgänge geben { "items": [...] } zurück und, wenn das Back-End weitere Seiten über Elements-Has-More / Elements-Next-Page-Token -Header signalisiert, ein Pagination -Objekt mit HasMore und NextPageToken ein.

Fehlgeschlagene Aufrufe werden mit Failure, dem HTTP-Status als Message und dem Servertext als Instructions angezeigt.

Zugehörig

• uip is connections – --connection-id Werte stammen aus connections list / connections create.
• uip is connectors – Erkennen Sie zuerst den Connectorschlüssel.
• uip is activities – sehen Sie sich die benannten Vorgänge an, die ein Connector verfügbar macht.
• uip is triggers – ereignisgesteuerte Entsprechungen zu den Verben auf Datenebene hier.

Siehe auch

• Übersicht über das Integration Service-Tool
• Globale Optionen
• Exitcodes