Entités df uip

Syntaxe et options pour les « entités df uip», qui parcourt et modifie les schémas d'entité Data Fabric.

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), la création (create, update) et la suppression (delete); les opérations au niveau de l’enregistrement sont exécutées sur uip df records.

Synthèse

uip df entities list [--native-only] [--folder-key <key> | --include-folders]
uip df entities get <id> [--folder-key <key>]
uip df entities create <name> (-f <path> | --body <json>) [--folder-key <key>]
uip df entities update <id> (-f <path> | --body <json>) [-y --reason <text>] [--folder-key <key>]
uip df entities delete <id> -y --reason <text> [--folder-key <key>]

Verbes

Verbe	Objectif
list	Lister des entités. La valeur par défaut est les entités au niveau du locataire; --folder-key s'étend à un dossier, --include-folders inclut les entités de chaque dossier ainsi que celles au niveau du locataire.
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	Mettre à jour les métadonnées ou le schéma d'une entité — ajouter des champs, mettre à jour les métadonnées des champs ou supprimer des champs (destructeur, nécessite -y/--reason).
delete	Supprimez une entité directement (irréversible, nécessite -y/--reason).

--folder-key, --native-only, --include-folders

--folder-key <key> (un GUID de dossier) étend un verbe à une entité au niveau du dossier au lieu du locataire. Elle est acceptée pour chaque verbe de ce groupe. Sur list, il s'exclut mutuellement avec --include-folders (qui répertorie les entités au niveau du locataire ainsi que les entités de chaque dossier en un seul appel). --native-only (sur list uniquement) filtre les entités fédérées, — celles qui sont prises en charge par une connexion de connecteur externe (identifiée par un tableau externalFields non vide).

liste d'entités uip df

Répertoriez les entités Data Fabric.

Options

Short	Long	Valeur (Value)	Default	Description
—	--native-only	Drapeau	désactivé	Afficher uniquement les entités natives; exclure les entités fédérées avec des connexions externes.
—	--folder-key	touche	—	Clé de dossier pour étendre la liste à un dossier spécifique. Capture mutuellement exclusive avec --include-folders.
—	--include-folders	Drapeau	désactivé	Répertoriez les entités au niveau du locataire ainsi que les entités de chaque dossier visible. Capture mutuellement exclusive avec --folder-key.

Exemples

uip df entities list --native-only

uip df entities list --folder-key f1000000-0000-0000-0000-000000000001

Format des données (--sortie json)

{
  "Code": "EntityList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Invoice",
      "displayName": "Invoice",
      "entityType": "Standard",
      "description": "Invoice records",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "isRbacEnabled": false,
      "fields": [
        { "id": "f1000000-0000-0000-0000-000000000001", "name": "amount" }
      ],
      "externalFields": []
    }
  ]
}

Important :

Data lignes ici sont les objets bruts du SDK, en camelCase - contrairement à la réponse de get ci-dessous, list ne nomme pas de champ PascalCase et ne modifie pas la charge utile. Le folderId de chaque ligne est la valeur à transmettre en tant que --folder-key lors des commandes de suivi ciblant cette entité.

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
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemple

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

Format des données (--sortie json)

{
  "Code": "EntitySchema",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "EntityType": "Standard",
    "Description": "Invoice records",
    "IsRbacEnabled": false,
    "Fields": [
      {
        "Id": "f1000000-0000-0000-0000-000000000002",
        "Name": "amount",
        "DisplayName": "Amount",
        "FieldDataType": {
          "Name": "DECIMAL",
          "DecimalPrecision": 2,
          "MinValue": 0,
          "MaxValue": 999999
        },
        "IsRequired": true,
        "IsUnique": false,
        "IsEncrypted": false,
        "IsRbacEnabled": false,
        "IsPrimaryKey": false,
        "IsSystemField": false
      }
    ]
  }
}

Contrairement à list, cette réponse est PascalCase. Le nom du type de champ et ses contraintes (DecimalPrecision, MinValue, MaxValue, LengthLimit, etc., selon le type) sont imbriqués sous FieldDataType, et non sous forme de propriétés plates sur le champ.

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

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
-f	--file	Chemin d'accès	—	Chemin d’accès à un fichier JSON avec la définition de l’entité (tableau fields requis; displayName, description, isRbacEnabled, isAnalyticsEnabled facultatif).
—	--body	JSON	—	Définition de l'entité JSON intégrée, même forme que --file.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier cible, pour créer une entité à l'échelle du dossier au lieu d'une entité au niveau du locataire.

Objet de définition d’entité:

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

Important :

Chaque objet de champ nécessite name, et non fieldName — la transmission de fieldName échoue avec l'erreur de validation Each field must include a 'name' string. Un objet de champ copié textuellement à partir de la sortie de entities get (qui utilise Name/FieldDataType, PascalCase) est également accepté ici et normalisé automatiquement à cette forme d'écriture plate.

Les valeurs type valides proviennent de l’enum EntityFieldDataType du SDK — un type non valide échoue avec une ValidationError répertoriant l’ensemble autorisé. Au-delà des types scalaires simples (STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME,...), plusieurs types prennent des propriétés supplémentaires requises sur l'objet de champ:

Saisie de texte	Propriétés requises supplémentaires
CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE	choiceSetId — UUID de df choice-sets list
RELATIONSHIP	referenceEntityId (UUID de l'entité cible, à partir de entities list) et referenceFieldId (UUID d'un champ sur l'entité cible, à partir de entities get <target-id>). Option referenceFolderKey lorsque l'entité cible réside dans un dossier différent.
FILE	Uniquement name et type — le serveur connecte automatiquement la référence interne de pièce jointe. Renseignez la valeur ultérieurement avec uip df files upload.
MULTILINE_MAX	Facultatif lengthLimit (budget UTF-16 octets, 1 à 13 1072; la valeur par défaut est environ 65 536 caractères). Impossible de filtrer ou de trier; records list/query ne renvoie qu'un marqueur de taille — lire le contenu complet avec records get. Limité par l'indicateur de fonctionnalité MultilineMax du locataire.

La colonne RELATIONSHIP d'un enregistrement stocke toujours le Id de l'enregistrement cible, quel que soit le referenceFieldId qui a configuré la jointure. Voir records insert pour savoir comment écrire la valeur.

Exemples

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

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

# choice-set, relationship, file, and large-text fields
uip df entities create Expense \
    --body '{"displayName":"Expense","fields":[{"name":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"name":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"name":"receipt","type":"FILE"},{"name":"notes","type":"MULTILINE_MAX"}]}'

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, removeFields, displayName, description et isAnalyticsEnabled/isRbacEnabled. L'entité name est elle-même immuable; elle ne peut pas être incluse dans le corps de la mise à jour.

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 mise à jour.
—	--body	JSON	—	Options de mise à jour JSON intégrées.
-y	--yes	Drapeau	—	Requis lorsque la valeur removeFields n’est pas vide — reconnaît que la suppression du champ est irréversible.
—	--reason	text	—	Obligatoire lorsque la valeur removeFields n'est pas vide — répercutée dans la réponse afin que l'appelant puisse l'enregistrer.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

• addFields — tableau de nouveaux champs, forme d'écriture plate (name + type, plus des extras spécifiques au type — voir la section create ci-dessus). Un objet de champ copié à partir de entities get est également accepté et normalisé.
• updateFields — tableau clé par champ id (depuis entities get), avec les propriétés des métadonnées modifiées (par exemple displayName, description, isRequired, isRbacEnabled, isEncrypted, isHiddenField, defaultValue, contraintes). Ne collez pas un objet de champ copié ici - transmettez id plus seules les propriétés plates sont modifiées. updateFields ne peut pas modifier la valeur type d’un champ ou son paramètre isUnique.
• removeFields — tableau de {"name": "<fieldName>"} objets, identifiés par nom, et non id. Nécessite -y/--yes et --reason "<text>" — l'opération supprime les valeurs stockées du champ et ne peut pas être annulée.
• La mise à jour des métadonnées de l'entité (description, isRbacEnabled, isAnalyticsEnabled) requiert que displayName soit également présent dans le même corps, même s'il est inchangé; récupérez d'abord le displayName actuel avec entities get si vous ne le faites pas l'avez déjà.

Exemples

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

# Rename an existing field's display name
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Amount (USD)","isRequired":true}]}'

# Remove a field — destructive, requires --yes and --reason
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"removeFields":[{"name":"oldColumn"}]}' \
    --yes --reason "quarterly cleanup"

Format des données (--sortie json)

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

Lorsque la mise à jour inclut removeFields, la réponse reprend également ce qui a été supprimé:

{
  "Code": "EntityUpdated",
  "Data": {
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedFields": ["oldColumn"],
    "Reason": "quarterly cleanup"
  }
}

suppression d’entités uip df

Supprimer une entité directement. Cette action est irréversible et supprime le schéma de l'entité ainsi que tous ses enregistrements.

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Requis. Confirme que cette opération est irréversible.
—	--reason	text	—	Requis. Motif de la suppression — renvoyé dans la réponse afin que l'appelant puisse la consigner.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemple

uip df entities delete a1b2c3d4-0000-0000-0000-000000000001 \
    --yes --reason "test entity cleanup"

Format des données (--sortie json)

{
  "Code": "EntityDeleted",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Reason": "test entity cleanup"
  }
}

Associé

• uip df records — gérez les lignes détenues par ces entités.
• uip df files — pièces jointes sur les enregistrements.
• uip df choice-sets — les ensembles de choix référencés par les champs CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .
• 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