UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

UIP-DF-Datensätze

uip df records verwaltet die von einer Data Fabric-Entität enthaltenen Zeilen. Verben decken Folgendes ab: Lesen (list, get, query), Schreiben (insert, update, import, delete) und Massenimport aus CSV. Verben mit einem einzelnen Datensatz geben den betroffenen Datensatz zurück; Batch-Verben geben Erfolgs-/Fehlschlaganzahlen zurück und beenden bei Teilfehlern ungleich Null. Liste und Abfragen unterstützen Cursor-basierte Paginierung.

Zusammenfassung

uip df records <verb> [options]
uip df records <verb> [options]

Verben

VerbZweck
listListen Sie Datensätze in einer Entität mit Cursor-basierter Paginierung auf.
getRufen Sie einen einzelnen Datensatz nach ID ab.
insertFügen Sie einen Datensatz (Objekt) oder mehrere (Array) ein.
updateEinen Datensatz (Objekt) oder viele (Array) aktualisieren; jedes muss Id enthalten.
queryFiltern, Sortieren und Projektdatensätze mithilfe eines JSON-Abfragetexts.
importMassenimport von Datensätzen aus einer CSV-Datei.
deleteLöschen Sie einen oder mehrere Datensätze nach ID.

UIP-DF-Datensatzliste

Listen Sie Datensätze in einer Entität auf. Unterstützt die Cursor-basierte Paginierung.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID). Finden Sie es mit entities list.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-l--limitNummer50Anzahl der Datensätze, die pro Seite zurückgegeben werden sollen.
-o--offsetNummerBeginnen Sie mit der Seite, die diesen Datensatzindex enthält (abgerundet auf eine Seitengrenze). Sich gegenseitig mit --cursor ausschließen.
--cursorCursorPaginierungscursor aus einer vorherigen Antwort.

Beispiele

uip df records list a1b2c3d4-0000-0000-0000-000000000001 --limit 2

# Continue paging
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --cursor "eyJwYWdlIjoyfQ=="

# Just the IDs
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Records[].Id'
uip df records list a1b2c3d4-0000-0000-0000-000000000001 --limit 2

# Continue paging
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --cursor "eyJwYWdlIjoyfQ=="

# Just the IDs
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Records[].Id'

Datenform (--output json)

{
  "Code": "RecordList",
  "Data": {
    "TotalCount": 2,
    "Records": [
      { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 }
    ],
    "HasNextPage": false
  }
}
{
  "Code": "RecordList",
  "Data": {
    "TotalCount": 2,
    "Records": [
      { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 }
    ],
    "HasNextPage": false
  }
}

Wenn mehrere Seiten vorhanden sind, hat die Antwort auch NextCursor, CurrentPage und TotalPages. Übergeben Sie NextCursor als --cursor zurück, um fortzufahren.

Abrufen von UIP-DF-Datensätzen

Rufen Sie einen einzelnen Datensatz nach ID ab.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).
<key>jaDatensatz-ID (UUID).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip df records get a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001
uip df records get a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "RecordDetails",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "amount": 1500,
    "status": "Paid"
  }
}
{
  "Code": "RecordDetails",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "amount": 1500,
    "status": "Paid"
  }
}

Einfügen von UIP-DF-Datensätzen

Fügen Sie einen oder mehrere Datensätze ein. Die Eingabe kann ein einzelnes JSON-Objekt oder ein Array von Objekten sein.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-f--filePfadPfad zur JSON-Datei mit Datensatzdaten (Objekt oder Array von Objekten).
--bodyJSONInline-JSON-Datensatzdaten.

Beispiele

# Single record
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"amount":1500,"status":"New"}'

# Batch from file
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.json
# Single record
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"amount":1500,"status":"New"}'

# Batch from file
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.json

Datenform (--output json)

Das Einfügen eines einzelnen Datensatzes gibt Code: "RecordInserted" mit dem erstellten Datensatz zurück. Batch-Einfügung gibt Code: "RecordsBatchInserted" zurück:

{
  "Code": "RecordsBatchInserted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000010" } ],
    "FailureRecords": []
  }
}
{
  "Code": "RecordsBatchInserted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000010" } ],
    "FailureRecords": []
  }
}

Wenn ein Datensatz in einem Batch fehlschlägt, wird der Befehl ungleich Null beendet, während weiterhin das vollständige Ergebnis ausgegeben wird.

Aktualisierung der UIP-DF-Datensätze

Aktualisieren Sie einen oder mehrere Datensätze. Jeder Datensatz muss ein Id (oder id) Feld enthalten.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-f--filePfadPfad zur JSON-Datei mit Datensatzdaten (muss das Feld Id enthalten).
--bodyJSONInline-JSON-Datensatzdaten (muss das Feld Id enthalten).

Beispiele

uip df records update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"Id":"b2c3d4e5-0000-0000-0000-000000000001","status":"Paid"}'
uip df records update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"Id":"b2c3d4e5-0000-0000-0000-000000000001","status":"Paid"}'

Datenform (--output json)

Einzelne Aktualisierungen geben Code: "RecordUpdated" aus; Batch-Updates geben Code: "RecordsBatchUpdated" mit der gleichen Form wie RecordsBatchInserted aus. Fehlende Id -Felder schlagen mit Failure vor dem Schreiben fehl.

Abfrage von uip-df-Datensätzen

Abfragen von Datensätzen mit Filter-, Sortier- und Feldauswahloptionen. Unterstützt die Cursor-basierte Paginierung. Der Textkörper ist ein JSON-Objekt mit optionalen Schlüsseln filterGroup, sortOptions (Array von { fieldName, isDescending }) und selectedFields (Array von Namen).

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-f--filePfadPfad zur JSON-Datei mit Abfrageoptionen.
--bodyJSONInline-JSON-Abfrageoptionen.
-l--limitNummer50Seitengröße.
-o--offsetNummerBeginnen Sie mit der Seite, die diesen Datensatzindex enthält. Sich gegenseitig mit --cursor ausschließen.
--cursorCursorPaginierungscursor aus einer vorherigen Antwort.

Beispiele

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"field":"status","operator":"eq","value":"Paid"}}'

# Sort newest first, project two fields
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"sortOptions":[{"fieldName":"createdAt","isDescending":true}],"selectedFields":["Id","amount"]}'
# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"field":"status","operator":"eq","value":"Paid"}}'

# Sort newest first, project two fields
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"sortOptions":[{"fieldName":"createdAt","isDescending":true}],"selectedFields":["Id","amount"]}'

Datenform (--output json)

{
  "Code": "RecordQuery",
  "Data": {
    "TotalCount": 2,
    "Records": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 } ],
    "HasNextPage": false
  }
}
{
  "Code": "RecordQuery",
  "Data": {
    "TotalCount": 2,
    "Records": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 } ],
    "HasNextPage": false
  }
}

Importieren von UIP-DF-Datensätzen

Massenimport von Datensätzen aus einer CSV-Datei.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-f--filePfaderforderlichPfad zur zu importierenden CSV-Datei.

Beispiele

uip df records import a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.csv
uip df records import a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.csv

Datenform (--output json)

{
  "Code": "RecordsImported",
  "Data": {
    "InsertedRecords": 42,
    "TotalRecords": 42
  }
}
{
  "Code": "RecordsImported",
  "Data": {
    "InsertedRecords": 42,
    "TotalRecords": 42
  }
}

Wenn der Server Fehler auf Zeilenebene aufzeichnet, enthält die Antwort auch ErrorFileLink das auf einen herunterladbaren Fehlerbericht verweist.

UIP-DF-Datensätze löschen

Löschen Sie einen oder mehrere Datensätze nach ID.

Argumente

NameErforderlichZweck
<id>jaEntitäts-ID (UUID).
<key...>jaMindestens eine zu löschende Datensatz-ID.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

# Bulk delete
uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000002 \
    b2c3d4e5-0000-0000-0000-000000000003
uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

# Bulk delete
uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000002 \
    b2c3d4e5-0000-0000-0000-000000000003

Datenform (--output json)

{
  "Code": "RecordsDeleted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001" } ],
    "FailureRecords": []
  }
}
{
  "Code": "RecordsDeleted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001" } ],
    "FailureRecords": []
  }
}

Bei einem Teilfehler wird weiterhin die vollständige Antwort ausgegeben, der Austrittscode wird jedoch auf 1 festgelegt.

  • uip df entities – erkennen Sie zuerst die Entitäts-ID; Überprüfen Sie das Schema, bevor Sie Abfragen erstellen.
  • uip df files – Verwalten Sie Dateianhänge für die Datensätze hier.

Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben