registros df de uip

Sintaxis y opciones para `registros uip df`, que gestiona filas en una entidad de Data Fabric, incluidas las operaciones de registro único y por lotes.

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. list y query admiten la paginación basada en cursores.

Sinopsis

uip df records list <id> [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records get <id> <key> [--folder-key <key>]
uip df records insert <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records update <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records query <id> (-f <path> | --body <json>) [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records import <id> -f <csv-path> [--folder-key <key>]
uip df records delete <id> <key...> -y --reason <text> [--folder-key <key>]

Cada verbo también acepta --folder-key <key> (un GUID de carpeta, para registros que pertenecen a una entidad de ámbito de carpeta).

Verbos

Verbo	Propósito
list	Enumerar registros en una entidad, con paginación basada en cursores.
get	Obtener un único registro por ID.
insert	Inserta un registro (objeto) o muchos (matriz).
update	Actualizar un registro (objeto) o muchos (matriz); cada uno debe incluir Id.
query	Filtra, ordena, agrega y proyecta registros utilizando un cuerpo de consulta JSON.
import	Importar registros de forma masiva desde un archivo CSV.
delete	Eliminar uno o más registros por ID (destructivo, requiere -y/--reason).

lista de registros df de uip

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

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID). Encuéntralo con entities list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit	Número	50	Número de registros que devolver por página.
-o	--offset	Número	—	Comience desde la página que contiene este índice de registro (redondeado a un límite de página). Mutuamente excluyente con --cursor.
—	--cursor	Cursor	—	Valor del cursor de paginación de un nextCursor.value de respuesta anterior. Mutuamente exclusivo con --offset.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplos

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

# Continue paging — pass the string from the previous response's Data.nextCursor.value
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.items[].Id'

Forma de datos (--json de salida)

{
  "Code": "RecordList",
  "Data": {
    "items": [
      {
        "Id": "b2c3d4e5-0000-0000-0000-000000000001",
        "amount": 1500,
        "notes": "HasValue=true Length=20000"
      },
      { "Id": "b2c3d4e5-0000-0000-0000-000000000002", "amount": 2750, "notes": null }
    ],
    "totalCount": 2,
    "hasNextPage": false
  }
}

Importante:

Las claves del sobre de paginación (items, totalCount, hasNextPage y, cuando existe otra página, nextCursor, previousCursor, currentPage, totalPages) son camelCase, a diferencia de las propias filas de registro Id . Cuando hasNextPage es true, pasa Data.nextCursor.value (una cadena) como --cursor, no el objeto nextCursor completo.

Un campo MULTILINE_MAX en list devuelve solo un marcador de tamaño ("HasValue=true Length=20000" o null si está vacío), no el texto completo; lee el valor completo con get a continuación.

Obtener registros df de uip

Obtener un único registro por ID.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).
<key>	Sí	ID de registro (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplo

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

A diferencia de list, un campo MULTILINE_MAX aquí devuelve su valor completo, no un marcador de tamaño.

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

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	—	Ruta al archivo JSON con datos de registro (objeto o matriz de objetos).
—	--body	JSON	—	Datos de registro JSON en línea (usa - para leer desde la entrada estándar).
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Valores de campo para tipos especiales:

• CHOICE_SET_SINGLE — el valor de elección numberId (un número entero, no la cadena de nombre) — búscalo con df choice-sets list-values <id>.
• CHOICE_SET_MULTIPLE : una matriz de numberId enteros.
• RELATIONSHIP : siempre el Id del registro de destino (un UUID), independientemente de qué referenceFieldId utilice el esquema para la unión: referenceFieldId solo configura la unión, no es el valor almacenado.
• FILE : no se puede establecer a través de insert/update; el campo se detecta automáticamente a partir del esquema de la entidad y se rechaza si está presente en la carga útil. Rellénelo después con uip df files upload.

Ejemplos

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

# Choice-set and relationship fields
uip df records insert a1b2c3d4-0000-0000-0000-000000000004 \
    --body '{"category":0,"tags":[1,3],"submitter":"e1f2a3b4-0000-0000-0000-000000000001","amount":250}'

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

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

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	—	Ruta al archivo JSON con datos de registro (debe incluir el campo Id ).
—	--body	JSON	—	Datos de registro JSON en línea (deben incluir el campo Id; use - para leer desde la entrada estándar).
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplo

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 filtrado, ordenación, agregación y selección de campos. Admite la paginación basada en cursores. El cuerpo es un objeto JSON con las claves opcionales filterGroup, sortOptions, selectedFields, aggregates y groupBy.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	—	Ruta al archivo JSON con opciones de consulta.
—	--body	JSON	—	Opciones de consulta JSON en línea (usa - para leer desde la entrada estándar).
-l	--limit	Número	50	Tamaño de la página.
-o	--offset	Número	—	Comience desde la página que contiene este índice de registro. Mutuamente excluyente con --cursor.
—	--cursor	Cursor	—	Valor del cursor de paginación de un nextCursor.value de respuesta anterior.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Claves del cuerpo de la consulta

• filterGroup — { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }. logicalOperator acepta la forma de cadena (no distingue entre mayúsculas y minúsculas) o la forma entera (0 = AND, 1 = OR); filterGroups anida grupos de la misma forma para condiciones compuestas.

• Las entradas queryFilters son { "fieldName": "<field>", "operator": "<op>", "value": ... } (o "valueList": [...] para in/not in). fieldName debe comenzar con una letra y contener solo letras, dígitos, guiones bajos y puntos.

  Importante:

  Los operadores compatibles son exactamente: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in. No hay eq, ==, Equals, like, BETWEEN, o operador regex — el servidor rechaza cualquier cosa fuera de este conjunto. Componga un BETWEEN como >= + <= en el mismo grupo queryFilters.

• sortOptions — matriz de { "fieldName": "<field>", "isDescending": true | false }.

• selectedFields — matriz de nombres de campo para proyectar.

• aggregates : matriz de hasta 5 objetos { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } . alias es opcional y, cuando se proporciona, debe comenzar con una letra (solo letras, dígitos, guiones bajos, ≤128 caracteres).

• groupBy — matriz de hasta 5 nombres de campo por los que agrupar agregados.

Ejemplos

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"status","operator":"=","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"]}'

# Aggregate — COUNT grouped by a field
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}],"groupBy":["status"]}'

Forma de datos (--json de salida)

{
  "Code": "RecordQuery",
  "Data": {
    "items": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "status": "Paid" } ],
    "totalCount": 1,
    "hasNextPage": false
  }
}

Las filas de una consulta agregada llevan los valores del campo groupBy más el alias de cada agregado en lugar de campos de registro completos:

{
  "Code": "RecordQuery",
  "Data": {
    "items": [
      { "status": "Paid", "total": 12 },
      { "status": "Pending", "total": 3 }
    ]
  }
}

Importar registros df de uip

Importar registros de forma masiva desde un archivo CSV.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	obligatorio	Ruta al archivo CSV a importar.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplo

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

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. Esto es irreversible.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).
<key...>	Sí	Uno o más ID de registro para eliminar.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-y	--yes	Marca	—	Obligatorio. Confirma que se trata de una operación irreversible.
—	--reason	text	—	Obligatorio. Motivo de la eliminación: se repite en la respuesta para que la persona que llama pueda registrarlo.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplos

uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    --yes --reason "test cleanup"

# 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 \
    --yes --reason "test cleanup"

Forma de datos (--json de salida)

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

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

Relacionado

• 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í.
• uip df choice-sets : busca valores numberId para los campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .

Ver también

• Descripción general de la herramienta Data Fabric
• Opciones globales
• Códigos de salida