Entités df uip

uip df entities navigue à travers les schémas d'entité Data Fabric. Une entité est un modèle de données saisie - une forme de ligne avec des champs et des types nommés. Les verbes couvrent la découverte (list, get) et la création (create, update); les opérations au niveau de l’enregistrement sont exécutées sur uip df records. La suppression des champs n'est intentionnellement pas prise en charge via update.

Synthèse

uip df entities <verb> [options]

Verbes

Verbe	Objectif
list	Répertorier toutes les entités dans le locataire; vous pouvez éventuellement exclure les fédérés.
get	Renvoyez le schéma (y compris tous les champs) d'une entité unique.
create	Créez une nouvelle entité à partir d’une définition JSON.
update	Mettez à jour les métadonnées ou le schéma d'une entité (ajout ou mise à jour des champs; removeFields est rejeté).

liste d'entités uip df

Répertorier toutes les entités dans le locataire.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--native-only	Drapeau	désactivé	Afficher uniquement les entités natives; exclure les entités fédérées reposant sur une connexion de connecteur externe.

Exemples

uip df entities list

uip df entities list --native-only

uip df entities list \
    --output-filter 'Data[].{name:Name, id:ID, fields:FieldCount}'

Format des données (--sortie json)

{
  "Code": "EntityList",
  "Data": [
    {
      "Name": "Invoice",
      "DisplayName": "Invoice",
      "ID": "a1b2c3d4-0000-0000-0000-000000000001",
      "Type": "Standard",
      "Source": "Native",
      "Description": "Invoice records",
      "FieldCount": 8
    }
  ]
}

Les entités fédérées signalent Source comme Federated ou Federated (<connector>).

Obtenir les entités df uip

Renvoyez le schéma d'une entité unique, y compris tous les champs.

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

uip df entities get a1b2c3d4-0000-0000-0000-000000000001

# Just the field list
uip df entities get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Fields[].{name:Name, type:Type}'

Format des données (--sortie json)

{
  "Code": "EntitySchema",
  "Data": {
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "Type": "Standard",
    "Description": "Invoice records",
    "Fields": [
      {
        "ID": "f1000000-0000-0000-0000-000000000001",
        "Name": "id",
        "DisplayName": "ID",
        "Type": "Guid",
        "Required": true,
        "PrimaryKey": true,
        "System": true
      }
    ]
  }
}

création d’entités uip df

Créez une nouvelle entité. Le nom de l'entité doit commencer par une lettre et contenir uniquement des lettres, des chiffres et des traits de soulignement. Transmettez la définition soit en ligne (--body), soit à partir d'un fichier (--file); les deux s'excluant mutuellement.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom de l’entité (commence par une lettre; lettres, chiffres, traits de soulignement uniquement).

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec la définition de l’entité (tableau fields requis).
—	--body	JSON	—	Définition de l'entité JSON intégrée.

Objet de définition d’entité:

{
  "displayName": "Invoice",
  "description": "Invoice records",
  "isRbacEnabled": false,
  "fields": [
    { "fieldName": "title", "type": "STRING" }
  ]
}

Chaque champ doit inclure fieldName sous forme de chaîne. Les valeurs type valides sont extraites de l’enum EntityFieldDataType du SDK (par exemple, STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME). Les types non valides échouent avec ValidationError liste l’ensemble autorisé.

Exemples

uip df entities create Invoice --file ./invoice.entity.json

uip df entities create Invoice \
    --body '{"displayName":"Invoice","fields":[{"fieldName":"amount","type":"DECIMAL"}]}'

Format des données (--sortie json)

{
  "Code": "EntityCreated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

mise à jour des entités df uip

Mettez à jour les métadonnées ou le schéma d'une entité. Le corps accepte addFields, updateFields, displayName, description et isRbacEnabled. removeFields est intentionnellement rejeté — la suppression du champ n'est pas prise en charge. Chaque entrée addFields nécessite fieldName; chaque entrée updateFields nécessite id (découvrir les ID de champ avec entities get).

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec les options de mise à jour.
—	--body	JSON	—	Options de mise à jour JSON intégrées.

Exemples

# Add a field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"addFields":[{"fieldName":"status","type":"STRING"}]}'

# Rename an existing field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Total"}]}'

Format des données (--sortie json)

{
  "Code": "EntityUpdated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

Associé

• uip df records — gérez les lignes détenues par ces entités.
• uip df files — pièces jointes sur les enregistrements.
• uip vss generate — génère des types TypeScript à partir d'une exportation de schéma Data Fabric.

Voir également

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