UIP ist Connectors

Syntax und Optionen für „uip is connectors“, das den Connector-Katalog des Integration Service durchsucht und die Erkennungsmetadaten, das Schema und den Prüfungsverlauf eines Connectors überprüft.

uip is connectors durchsucht den Integration Service Connector-Katalog – jede Integration, gegen die sich der Mandant authentifizieren kann (Salesforce, Slack, Zoho Desk usw.) – und überprüft die Erkennungsmetadaten eines Connectors, das OpenAPI-Dokument, Ereignisvorgänge und den Prüfungsverlauf. Es ist schreibgeschützt: Keines dieser Verben erstellt oder ändert einen Connector. list speichert das Ergebnis pro Mandant auf dem Datenträger; Übergeben Sie --refresh, um einen erneuten Abruf zu erzwingen. get und jedes andere Verb unten rufen die API immer direkt auf und unberührt von diesem Cache.

Zusammenfassung

uip is connectors <verb> [options]

Verben

Verb	Zweck
list	Listen Sie die für den Mandanten verfügbaren Connectors auf; Optional nach Name oder Schlüssel filtern.
get	Vollständige Details für einen Connector nach Schlüssel abrufen.
metadata	Rufen Sie die Erkennungsmetadaten eines Connectors ab (Funktionsflags, Stufe, Erkennungstyp).
swagger	Rufen Sie das OpenAPI-Dokument für ein Connector-Element ab.
event-operations	Listen Sie die Ereignisvorgänge auf, die ein Connector-Element unterstützt.
audit-logs	Prüfungsprotokolleinträge für eine Connector-Elementversion auflisten.
export	Das Paket eines Connector-Elements in eine lokale Datei exportieren.

UIP ist Connectors-Liste

Listen Sie Connectors auf, die für den aktuellen Mandanten verfügbar sind. Pro Mandant auf dem Datenträger zwischengespeichert.

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--filter	text	–	Teilzeichenfolge stimmt mit Connector-Name oder -Schlüssel überein.
–	--refresh	Markieren	aus	Erzwingen Sie den erneuten Abruf über die API und ignorieren Sie den Cache.

Beispiele

uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'

Datenform (--output json)

{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}

Wenn keine Connectors übereinstimmen, ist der Befehl mit Code: "Message" und Data: { "Message": "No connectors found." } erfolgreich.

UIP ist Connectors abrufen

Vollständigen Datensatz für einen Connector nach Schlüssel zurückgeben. Ruft die API immer direkt auf – nicht zwischengespeichert.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel, z. B. uipath-zoho-desk. Finden Sie es mit connectors list.

Optionen

Keine über die globalen Optionen hinaus.

Beispiele

uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'

Datenform (--output json)

{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}

Vollständige Feldliste (alle zurückgegeben): Id, Name, Key, AppName, Vendor, Description, Image, Active, HasEvents, HasCruds, HasMethods, HasHttpRequest, DapCompatible, Categories, Tags, DocumentationUrl. Description liest "No description" und DocumentationUrl liest "No documentation", wenn der Katalog nichts auf der Datei für diesen Connector als eine leere Zeichenfolge enthält.

UIP ist Connector-Metadaten

Rufen Sie die Erkennungsmetadaten eines Connectors ab: Funktions-Flags (unterstützt es Ereignisse, CRUD, benutzerdefinierte Objekt-/Felderkennung, …), Stufe, Erkennungstyp und alle mandantenspezifischen Feature-Flags.

Argumente

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

Optionen

Keine über die globalen Optionen hinaus.

Beispiel

uip is connectors metadata uipath-salesforce-sfdc

Datenform (--output json)

{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}

Hinweis:

Der Befehl zeigt jede boolesche Eigenschaft an, die der Katalog für einen Connector zurückgibt, nicht nur den oben gezeigten festen Satz – ein neues Funktions-Flag, das dem Katalog hinzugefügt wurde, wird hier automatisch angezeigt, ohne auf eine CLI-Version zu warten.

UIP ist Connectors Swagger

Rufen Sie das OpenAPI-Dokument (Swagger) ab, das die Vorgänge eines Connector-Elements beschreibt.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.

Optionen

Long	Wert	Beschreibung
--version	text	Elementversion Lassen Sie die Verwendung der standardmäßigen/neuen Version des Connectors weg.

Beispiel

uip is connectors swagger uipath-zoho-desk

Datenform (--output json)

{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}

Data ist das unbearbeitete OpenAPI-Dokument, das vom Katalog zurückgegeben wird – seine Form folgt den OpenAPI-Spezifikationen und nicht den üblichen PascalCase-Umschlagkonventionen dieser CLI.

uip ist Connectors für Ereignisvorgänge

Listen Sie die Ereignisvorgänge auf, die ein Connector-Element unterstützt (die Vorgänge, die für diesen Connector für uip is triggers verfügbar sind).

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.

Optionen

Long	Wert	Beschreibung
--version	text	Elementversion Lassen Sie die Verwendung der standardmäßigen/neuen Version des Connectors weg.

Beispiel

uip is connectors event-operations uipath-zoho-desk

Datenform (--output json)

{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}

Ein leeres Ergebnis ist weiterhin erfolgreich, mit Instructions: "No event operations found for connector '<connector-key>'.".

UIP ist Connectors Prüfungsprotokolle

Listen Sie Prüfungsprotokolleinträge auf, die für eine Connector-Elementversion aufgezeichnet wurden (Schemaänderungen, Veröffentlichungen und ähnliche katalogseitige Ereignisse).

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.

Optionen

Long	Wert	Beschreibung
--version	text	Erforderlich. Elementversion, für die Prüfungsprotokolle abgerufen werden sollen.
--limit	Nummer	Seitengröße.
--next-page	Token	Cursor von einer vorherigen Antwort, um die nächste Seite abzurufen.

Beispiel

uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50

Datenform (--output json)

{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "[e-mail]" }
  ]
}

Ein leeres Ergebnis ist weiterhin erfolgreich, mit Instructions: "No audit logs found for connector '<connector-key>' version '<version>'.".

UIP ist Connectors-Export

Das Paket eines Connector-Elements in eine lokale Datei exportieren.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel.

Optionen

Long	Wert	Beschreibung
--output-file	Pfad	Erforderlich. Pfad der Zieldatei.
--version	text	Elementversion Lassen Sie die Verwendung der standardmäßigen/neuen Version des Connectors weg.

Beispiel

uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip

Datenform (--output json)

{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}

Version gibt alles zurück, was --version übergeben wurde (leere Zeichenfolge, wenn weggelassen) – es wird nicht in die tatsächliche exportierte Versionsnummer aufgelöst.

Zugehörig

• uip is connections – Erstellen Sie OAuth-Sitzungen für die hier erkannten Connectors.
• uip is activities – listet die Vorgänge auf, die ein Connector verfügbar macht.
• uip is resources – beschreiben und führen Sie die Datenebenenobjekte eines Connectors aus.
• uip is triggers – ereignisgesteuerte Connector-Vorgänge, unterstützt durch event-operations oben.

Siehe auch

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