enregistrements df uip

Syntaxe et options pour `uip df enregistrements`, qui gère les lignes dans une entité Data Fabric, y compris les opérations à enregistrement unique et par lots.

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.

Synthèse

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).

Verbes

Verbe	Objectif
list	Répertorie les enregistrements dans une entité, avec une pagination basée sur un curseur.
get	Obtenez un seul enregistrement par ID.
insert	Insérez un enregistrement (objet) ou plusieurs (tableaux).
update	Mettez à jour un enregistrement (objet) ou plusieurs (tableaux); chacun doit inclure Id.
query	Filter, sort, aggregate, and project records using a JSON query body.
import	Importez en bloc des enregistrements à partir d’un fichier CSV.
delete	Delete one or more records by ID (destructive, requires -y/--reason).

liste d'enregistrements uip df

Répertorier les enregistrements dans une entité. Prend en charge la pagination basée sur des curseurs.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité. Recherchez-le avec entities list.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Nombre d'enregistrements à renvoyer par page.
-o	--offset	Numérique	—	Commencez par la page contenant cet index d’enregistrement (arrondi à une limite de page). Capture mutuellement exclusive avec --cursor
—	--cursor	Curseur	—	Pagination cursor value from a previous response's nextCursor.value. Mutually exclusive with --offset.
—	--folder-key	touche	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemples

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'

Format des données (--sortie 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
  }
}

Important :

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.

Obtenir les enregistrements uip df

Obtenez un seul enregistrement par ID.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.
<key>	oui	ID d’enregistrement.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-key	touche	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemple

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

Format des données (--sortie 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.

insertion d'enregistrements uip df

Insérez un ou plusieurs enregistrements. L'entrée peut être un objet JSON unique ou un tableau d'objets.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec des données d’enregistrement (objet ou tableau d’objets).
—	--body	JSON	—	Inline JSON record data (use - to read from stdin).
—	--folder-key	touche	—	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.

Exemples

# 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

Format des données (--sortie json)

L'insertion d'un enregistrement unique renvoie Code: "RecordInserted" avec l'enregistrement créé. L'insertion par lots renvoie Code: "RecordsBatchInserted":

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

Si un enregistrement échoue dans un lot, la commande se termine non-zéro tout en émettant le résultat complet.

mise à jour des enregistrements uip df

Mettez à jour un ou plusieurs enregistrements. Chaque enregistrement doit inclure un champ Id (ou id).

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec des données d’enregistrement (doit inclure le champ Id ).
—	--body	JSON	—	Inline JSON record data (must include Id field; use - to read from stdin).
—	--folder-key	touche	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemple

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

Format des données (--sortie json)

Mises à jour à émission unique Code: "RecordUpdated"; les mises à jour par lots génèrent Code: "RecordsBatchUpdated" avec la même forme que RecordsBatchInserted. Les champs Id manquants échouent avec Failure avant toute écriture.

requête d’enregistrements 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.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec les options de requête.
—	--body	JSON	—	Inline JSON query options (use - to read from stdin).
-l	--limit	Numérique	50	Taille de la page.
-o	--offset	Numérique	—	Commencez à partir de la page contenant cet index d’enregistrement. Capture mutuellement exclusive avec --cursor
—	--cursor	Curseur	—	Pagination cursor value from a previous response's nextCursor.value.
—	--folder-key	touche	—	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.

  Important :

  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.

Exemples

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

Format des données (--sortie 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 }
    ]
  }
}

importation d'enregistrements uip df

Importez en bloc des enregistrements à partir d’un fichier CSV.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	requis	Chemin d’accès au fichier CSV à importer.
—	--folder-key	touche	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemple

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

Format des données (--sortie json)

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

Si le serveur enregistre des erreurs au niveau de la ligne, la réponse inclut également ErrorFileLink pointant vers un rapport d’erreur téléchargeable.

suppression d'enregistrements uip df

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

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.
<key...>	oui	Un ou plusieurs ID d’enregistrement à supprimer.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	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	touche	—	Folder key (GUID) of the folder containing the entity, for folder-scoped entities.

Exemples

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"

Format des données (--sortie json)

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

Un échec partiel génère toujours la réponse complète, mais définit le code de sortie 1.

Associé

• uip df entities — découvrez d'abord l'ID d'entité; inspecter le schéma avant de créer des requêtes.
• uip df files — gérez les pièces jointes des fichiers dans les enregistrements ici.
• uip df choice-sets — look up numberId values for CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE fields.

Voir également

• Présentation de l’outil Data Fabric
• Options globales
• Codes de sortie