UIP ist Ressourcen

Syntax und Optionen für „uip is resource“, die Objekte auf der Datenebene des Connectors 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 execute ruft die Datenebene des Connectors (Create/List/Get/Update/Replace/Delete) für eine Verbindung auf. Jedes execute -Verb erfordert --connection-id; Die zwischengespeicherten Metadaten (list, describe) akzeptieren es optional, um benutzerdefinierte Objekte/Felder aufzudecken.

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.
execute	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).
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--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 (z. B. tickets). Namen mit resources list finden.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--connection-id	id	–	Scope auf eine Verbindung (aktiviert benutzerdefinierte Felder).
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--operation	ENUM	–	List, Retrieve, Create, Update, Delete oder Replace.
–	--refresh	Markieren	aus	Erzwingen Sie den erneuten Abruf über die API und ignorieren Sie den Cache.

Beispiele

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

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.

UIP wird ausgeführt

Rufen Sie die Datenebene des Connectors auf. execute 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.

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

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.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--query	Parameter	–	Abfrageparameter. Akzeptiert key=value&key=value oder ein JSON-Objekt.
–	--body	JSON	–	Anforderungstext. Erforderlich für create, update, replace.

Beispiele

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

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