UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

registros df de uip

uip df records gestiona las filas de una entidad de Data Fabric. Los verbos cubren lectura (list, get, query), escritura (insert, update, import, delete) e importación masiva desde CSV. Los verbos de registro único devuelven el registro afectado; los verbos por lotes devuelven recuentos de éxito/fallo y salen distintos de cero en caso de fallo parcial. La lista y la consulta admiten la paginación basada en cursores.

Sinopsis

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

Verbos

VerboPropósito
listEnumerar registros en una entidad, con paginación basada en cursores.
getObtener un único registro por ID.
insertInserta un registro (objeto) o muchos (matriz).
updateActualizar un registro (objeto) o muchos (matriz); cada uno debe incluir Id.
queryFiltra, ordena y proyecta registros utilizando un cuerpo de consulta JSON.
importImportar registros de forma masiva desde un archivo CSV.
deleteEliminar uno o más registros por ID.

lista de registros df de uip

Enumerar registros en una entidad. Admite la paginación basada en cursores.

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID). Encuéntralo con entities list.

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
-l--limitNúmero50Número de registros que devolver por página.
-o--offsetNúmeroComience desde la página que contiene este índice de registro (redondeado a un límite de página). Mutuamente excluyente con --cursor.
--cursorCursorCursor de paginación de una respuesta anterior.

Ejemplos

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'

Forma de datos (--json de salida)

{
  "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
  }
}

Cuando existen más páginas, la respuesta también incluye NextCursor, CurrentPage y TotalPages. Devuelve NextCursor como --cursor para continuar.

Obtener registros df de uip

Obtener un único registro por ID.

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).
<key>ID de registro (UUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.

Ejemplos

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

Forma de datos (--json de salida)

{
  "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"
  }
}

inserción de registros df de uip

Inserta uno o más registros. La entrada puede ser un único objeto JSON o una matriz de objetos.

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
-f--fileRutaRuta al archivo JSON con datos de registro (objeto o matriz de objetos).
--bodyJSONDatos de registro JSON en línea.

Ejemplos

# 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

Forma de datos (--json de salida)

La inserción de un único registro devuelve Code: "RecordInserted" con el registro creado. La inserción por lotes devuelve Code: "RecordsBatchInserted":

{
  "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": []
  }
}

Si algún registro falla en un lote, el comando sale distinto de cero mientras sigue emitiendo el resultado completo.

actualización de registros df de uip

Actualice uno o más registros. Cada registro debe incluir un campo Id (o id).

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
-f--fileRutaRuta al archivo JSON con datos de registro (debe incluir el campo Id ).
--bodyJSONDatos de registro JSON en línea (deben incluir el campo Id ).

Ejemplos

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

Forma de datos (--json de salida)

Las actualizaciones individuales emiten Code: "RecordUpdated"; las actualizaciones por lotes emiten Code: "RecordsBatchUpdated" con la misma forma que RecordsBatchInserted. Los campos Id que faltan fallan con Failure antes de cualquier escritura.

consulta de registros df de uip

Consultar registros con opciones de filtro, ordenación y selección de campos. Admite la paginación basada en cursores. El cuerpo es un objeto JSON con claves opcionales filterGroup, sortOptions (matriz de { fieldName, isDescending }) y selectedFields (matriz de nombres).

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
-f--fileRutaRuta al archivo JSON con opciones de consulta.
--bodyJSONOpciones de consulta JSON en línea.
-l--limitNúmero50Tamaño de la página.
-o--offsetNúmeroComience desde la página que contiene este índice de registro. Mutuamente excluyente con --cursor.
--cursorCursorCursor de paginación de una respuesta anterior.

Ejemplos

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

Forma de datos (--json de salida)

{
  "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
  }
}

Importar registros df de uip

Importar registros de forma masiva desde un archivo CSV.

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
-f--fileRutaobligatorioRuta al archivo CSV a importar.

Ejemplos

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

Forma de datos (--json de salida)

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

Si el servidor registra errores en el nivel de fila, la respuesta también incluye ErrorFileLink apuntar a un informe de error descargable.

eliminar registros df de uip

Eliminar uno o más registros por ID.

Argumentos

NombreObligatorioPropósito
<id>ID de entidad (UUID).
<key...>Uno o más ID de registro para eliminar.

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.

Ejemplos

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

Forma de datos (--json de salida)

{
  "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": []
  }
}

Un fallo parcial sigue emitiendo la respuesta completa, pero establece el código de salida 1.

  • uip df entities : descubre primero el ID de la entidad; inspecciona el esquema antes de crear consultas.
  • uip df files : gestiona los archivos adjuntos en los registros aquí.

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado