entidades df uip

uip df entities busca y muta los esquemas de entidad de Data Fabric. Una entidad es un modelo de datos con tipo: una forma de fila con campos y tipos con nombre. Los verbos cubren el descubrimiento (list, get) y la creación (create, update); operaciones en el nivel de registro activas en uip df records. La eliminación de campos no se admite intencionadamente a través de update.

Sinopsis

uip df entities <verb> [options]

Verbos

Verbo	Propósito
list	Enumerar todas las entidades en el tenant; excluir opcionalmente los federados.
get	Devuelve el esquema (incluidos todos los campos) de una sola entidad.
create	Crea una nueva entidad a partir de una definición JSON.
update	Actualizar los metadatos o el esquema de una entidad (añadir o actualizar campos; removeFields se rechaza).

lista de entidades de uip df

Enumera todas las entidades del tenant.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--native-only	Marca	Desactivado	Mostrar solo entidades nativas; excluir las entidades federadas respaldadas por una conexión de conector externo.

Ejemplos

uip df entities list

uip df entities list --native-only

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

Forma de datos (--json de salida)

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

Las entidades federadas informan Source como Federated o Federated (<connector>).

las entidades uip df obtienen

Devuelve el esquema de una sola entidad, incluidos todos los campos.

Argumentos

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

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

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

Forma de datos (--json de salida)

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

creación de entidades uip df

Crear una nueva entidad. El nombre de la entidad debe comenzar con una letra y contener solo letras, números y guiones bajos. Pasar la definición en línea (--body) o desde un archivo (--file); ambos son mutuamente excluyentes.

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre de la entidad (comienza con una letra; solo letras, números, guiones bajos).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-f	--file	Ruta	—	Ruta al archivo JSON con la definición de la entidad (se requiere la matriz fields ).
—	--body	JSON	—	Definición de entidad JSON en línea.

Objeto de definición de entidad:

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

Cada campo debe incluir fieldName como cadena. Los valores type válidos se toman del enum EntityFieldDataType del SDK (por ejemplo, STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME). Los tipos no válidos fallan con ValidationError enumerando el conjunto permitido.

Ejemplos

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

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

Forma de datos (--json de salida)

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

actualización de entidades de uip df

Actualizar los metadatos o el esquema de una entidad. El cuerpo acepta addFields, updateFields, displayName, description y isRbacEnabled. removeFields se ha rechazado intencionadamente: no se admite la eliminación de campos. Cada entrada addFields requiere fieldName; cada entrada updateFields requiere id (descubre los ID de campo con entities get).

Argumentos

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

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-f	--file	Ruta	—	Ruta al archivo JSON con opciones de actualización.
—	--body	JSON	—	Opciones de actualización de JSON en línea.

Ejemplos

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

Forma de datos (--json de salida)

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

Relacionado

• uip df records : gestiona las filas de estas entidades.
• uip df files : archivos adjuntos en registros.
• uip vss generate : genera tipos de TypeScript a partir de una exportación de esquema de Data Fabric.

Ver también

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