registros uip df

Sintaxe e opções para "uip df Records", que gerencia linhas em uma entidade do Data Fabric, incluindo operações de registro único e em lote.

uip df records manages the rows held by a Data Fabric entity. Verbs cover read (list, get, query), write (insert, update, import, delete), and bulk import from CSV. Single-record verbs return the affected record; batch verbs return success/failure counts and exit non-zero on partial failure. list and query support cursor-based pagination.

Resumo

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

Every verb also accepts --folder-key <key> (a folder GUID, for records that belong to a folder-scoped entity).

Verbo

Texto	Finalidade
list	Lista os registros em uma entidade, com paginação baseada em cursor.
get	Obter um único registro por ID.
insert	Insira um registro (objeto) ou muitos (array).
update	Atualizar um registro (objeto) ou muitos (array); cada um deve incluir Id.
query	Filter, sort, aggregate, and project records using a JSON query body.
import	Importe registros em massa de um arquivo CSV.
delete	Delete one or more records by ID (destructive, requires -y/--reason).

lista de registros uip df

Listar os registros em uma entidade. Suporta paginação baseada em cursor.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID). Encontre-o com entities list.

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Número de registros a serem retornados por página.
-o	--offset	Número	—	Comece da página que contém esse índice de registro (arredondado para baixo para um limite de página). mutuamente exclusivo com --cursor.
—	--cursor	Cursor	—	Pagination cursor value from a previous response's nextCursor.value. Mutually exclusive with --offset.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemplos

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'

Formato dos dados (--output json)

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

The pagination envelope keys (items, totalCount, hasNextPage, and — when another page exists — nextCursor, previousCursor, currentPage, totalPages) are camelCase, unlike the record rows' own Id field. When hasNextPage is true, pass Data.nextCursor.value (a string) back as --cursor — not the whole nextCursor object.

A MULTILINE_MAX field on list returns only a size marker ("HasValue=true Length=20000" or null if empty), not the full text — read the full value with get below.

registros uip df obter

Obter um único registro por ID.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).
<key>	sim	ID de registro (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemplo

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

Formato dos dados (--output json)

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

Unlike list, a MULTILINE_MAX field here returns its complete value, not a size marker.

inserção de registros uip df

Insira um ou mais registros. A entrada pode ser um único objeto JSON ou um array de objetos.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (objeto ou array de objetos).
—	--body	JSON	—	Inline JSON record data (use - to read from stdin).
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Field values for special types:

• CHOICE_SET_SINGLE — the choice value's numberId (an integer, not the name string) — look it up with df choice-sets list-values <id>.
• CHOICE_SET_MULTIPLE — an array of numberId integers.
• RELATIONSHIP — always the target record's Id (a UUID), regardless of which referenceFieldId the schema uses for the join — referenceFieldId only configures the join, it isn't the stored value.
• FILE — cannot be set through insert/update; the field is auto-detected from the entity's schema and rejected if present in the payload. Populate it afterward with uip df files upload.

Exemplos

# 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

Formato dos dados (--output json)

A inserção de registro único retorna Code: "RecordInserted" com o registro criado. A inserção em lote retorna Code: "RecordsBatchInserted":

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

Se algum registro falhar em um lote, o comando sairá diferente de zero enquanto ainda emitindo o resultado completo.

Atualização de registros uip df

Atualize um ou mais registros. Cada registro deve incluir um campo Id (ou id).

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (deve incluir o campo Id ).
—	--body	JSON	—	Inline JSON record data (must include Id field; use - to read from stdin).
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemplo

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

Formato dos dados (--output json)

Atualizações únicas emitam Code: "RecordUpdated"; atualizações em lote emite Code: "RecordsBatchUpdated" com o mesmo formato que RecordsBatchInserted. Os campos Id ausentes falham com Failure antes de qualquer gravação.

consulta de registros uip df

Query records with filtering, sorting, aggregation, and field-selection. Supports cursor-based pagination. The body is a JSON object with optional keys filterGroup, sortOptions, selectedFields, aggregates, and groupBy.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com opções de consulta.
—	--body	JSON	—	Inline JSON query options (use - to read from stdin).
-l	--limit	Número	50	Tamanho da página
-o	--offset	Número	—	Comece da página que contém esse índice de registro. mutuamente exclusivo com --cursor.
—	--cursor	Cursor	—	Pagination cursor value from a previous response's nextCursor.value.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Query body keys

• filterGroup — { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }. logicalOperator accepts the string form (case-insensitive) or the integer form (0 = AND, 1 = OR); filterGroups nests groups of the same shape for compound conditions.

• queryFilters entries are { "fieldName": "<field>", "operator": "<op>", "value": ... } (or "valueList": [...] for in/not in). fieldName must start with a letter and contain only letters, digits, underscores, and dots.

  Importante:

  Supported operators are exactly: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in. There is no eq, ==, Equals, like, BETWEEN, or regex operator — the server rejects anything outside this set. Compose a BETWEEN as >= + <= in the same queryFilters group.

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

• selectedFields — array of field names to project.

• aggregates — array of up to 5 { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } objects. alias is optional and, when given, must start with a letter (letters, digits, underscores only, ≤128 chars).

• groupBy — array of up to 5 field names to group aggregates by.

Exemplos

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

Formato dos dados (--output json)

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

An aggregate query's rows carry the groupBy field values plus each aggregate's alias instead of full record fields:

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

importação de registros uip df

Importe registros em massa de um arquivo CSV.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	necessário	Caminho para o arquivo CSV a ser importado.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemplo

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

Formato dos dados (--output json)

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

Se o servidor registrar erros no nível da linha, a resposta também inclui ErrorFileLink apontando para um relatório de erros que pode ser baixado.

exclusão de registros uip df

Delete one or more records by ID. This is irreversible.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).
<key...>	sim	Um ou mais IDs de registro a serem excluídos.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Required. Acknowledges this is an irreversible operation.
—	--reason	text	—	Required. Reason for the deletion — echoed back in the response so the caller can log it.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemplos

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"

Formato dos dados (--output json)

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

Uma falha parcial ainda emite a resposta completa, mas define o código de saída 1

Relacionado

• uip df entities — descubra o ID da entidade primeiro; inspecione o esquema antes de criar consultas.
• uip df files — gerencie anexos de arquivo nos registros aqui.
• uip df choice-sets — look up numberId values for CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE fields.

Veja também

• Visão geral da ferramenta Data Fabric
• Opções globais
• Códigos de saída