uipath-data-fabric

name: uipath-data-fabric description: "UiPath Data Fabric entity/record CRUD via uip df. Create entities, insert/query/update/delete records, CSV import, file attachments. For Flow connector nodes (query/create/update/delete/get-by-id inside a .flow)→uipath-maestro-flow. For Orchestrator→uipath-platform. For Integration Service→uipath-platform."

UiPath Data Fabric — Agent Skill

Data Fabric is UiPath's structured data store. Entities are typed schemas; records are rows; file fields store binary attachments.

All operations go through uip df <subject> <verb> --output json.

When to Use

• Creating or modifying entity schemas (add fields, update metadata)
• Reading, inserting, updating, or deleting records
• Filtering records with complex predicates
• Computing aggregate metrics for dashboards / KPIs (counts, sums, averages, group-by) — see references/records-query.md
• Importing bulk data from CSV files
• Uploading or downloading file attachments on records

When NOT to Use — Hand Off to Another Skill

Embedding Data Fabric reads/writes inside a .flow file as connector activity nodes (Query / Create / Update / Delete / Get Entity Record by ID) is owned by uipath-maestro-flow. That skill knows the node JSON, bindings_v2.json, connection-resource layout, and node configure mechanics.

Use this skill (uipath-data-fabric) for entity discovery and record seeding from the CLI; hand off to uipath-maestro-flow for in-flow node authoring.

Not Supported — Never Attempt These

Respond that the operation is not supported. Do not try to work around it.

Critical Rules

1. Install the tool first. If uip df returns "unknown command": uip tools install @uipath/data-fabric-tool. See Tool Version Requirements below for the floor needed per feature.

2. Verify login and tenant first. Run uip login status --output json. Switch with uip login tenant set <tenant> if needed. For full login/environment setup, see the uipath-platform skill.

3. Always resolve entity ID first. Use entities list before any operation. Never assume an entity ID.

4. Entity and field names must pass validation: start with a letter, contain only letters/digits/underscores ([a-zA-Z0-9_]), 3–100 characters. No hyphens or spaces. Reserved field names that will error: Id, CreatedBy, CreateTime, UpdatedBy, UpdateTime. Also never use SQL, C#, or VB reserved keywords — common rejections: Case, Class, If, Then, Else, New, Object, Public, Return, Select, From, Where, Table, Order, Group, Index, Key, User, Role, Type, Status. The API surfaces these as "cannot be a reserved word in C# or VB" (or RESERVED_LANGUAGE_KEYWORDS). Pick domain-specific names: Case → WorkItem; Status → OrderStatus; Order → PurchaseOrder; Key → ItemKey.

5. All updates require Id in the body. The CLI routes single vs batch by whether the body is a JSON object (1 record) or array (multiple). Both require "Id" in the record. Use records list or records query to retrieve record IDs before updating.

6. File fields are separate from record data. Use files upload/download, not records insert. Field must be type FILE.

7. CSV headers must match exact field names (case-sensitive). Use entities get to discover field names before importing.

8. Never create duplicate entities. Always entities list first; reuse if it already exists.

9. Only work with native entities. When listing entities before a write, use entities list --native-only to filter out federated entities. Never write to federated entities.

10. Entity delete is irreversible — surface dependents first. entities delete <id> --confirm --reason "<why>" deletes the entity and every record in it. Before invoking, scan for dependents and list them to the user one by one: (a) other entities that reference this one (run entities list --output json and pull every entry whose Fields[].ReferenceEntity.Id == <id> — these will have broken FKs after the delete); (b) choice sets used by this entity's fields (Fields[].ChoiceSetId from entities get) — those choice sets are shared and may still be in use elsewhere. Ask the user explicitly for each dependent: delete it too, leave it, or stop. Apply only the choices the user confirms — never cascade silently.

11. Field delete is irreversible — surface impact first. entities update <id> --body '{"removeFields":[{"fieldName":"<name>"}]}' --confirm --reason "<why>" drops the field and every record's value in it. Note removeFields takes {"fieldName": "..."} (NOT {"id": "..."} like updateFields). Before invoking: (a) if it's a RELATIONSHIP / FILE field, identify any code or flows that read its value; (b) if it's a CHOICE_SET field, note the choice set itself is unaffected (still shared). Ask the user explicitly: confirm the field name, confirm the loss is intentional, supply a reason for the audit log. Apply only after explicit confirmation.

12. Complex field types need extra config and lookups, just like DECIMAL needs decimalPrecision. CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE require choiceSetId (UUID, from choice-sets list); RELATIONSHIP and FILE require referenceEntityId (target entity UUID — from entities list) + referenceFieldId (target field UUID — from entities get <target-id>). The target entity must exist first. When the user describes a link to another row ("each order has a Customer", "each report has a Supplier"), the field type is RELATIONSHIP — never substitute STRING or UUID for it. Full shape in references/entity-schema.md.

13. Pick-or-create flow for choice sets and relationship targets. When the user's request needs a choice set or a relationship target entity that they didn't name (or the name they gave doesn't exist), do NOT auto-create and do NOT fall back to STRING. Run choice-sets list / entities list --native-only, present the matching candidates by Name / DisplayName, and ask: pick from these, or create new? Create only with explicit user approval, using their chosen name and values. Choice-set authoring uses choice-sets create / update / delete + choice-set-values create / update / delete; surface in references/choice-sets.md.

14. Preview the proposed schema and get explicit approval before any create or schema-altering update. Applies to entities create, entities update with addFields / updateFields / removeFields, choice-sets create, and choice-set-values create. Sequence: (1) compose the full proposal — entity / choice-set name, displayName, description, and every field with its fieldName, normalized UPPERCASE type, and all extras (isRequired, isUnique, lengthLimit, maxValue / minValue, decimalPrecision, defaultValue, choiceSetId, referenceEntityId / referenceFieldId); (2) render it as a readable table or formatted JSON block (NOT a raw CLI command); (3) ask the user to confirm or revise — wait for an explicit yes / approved / proceed before invoking the CLI; (4) apply revisions exactly as requested — never silently add, drop, rename, or retype fields the user didn't approve; re-show the revised proposal and ask again. Show the proposal once per round — don't re-show an unchanged schema after every minor question.

15. Choice / relationship record values use lookup tokens, not labels. Choice value → integer NumberId (single) or array of NumberIds (multi), from choice-sets list-values. Relationship value → target record's UUID Id regardless of which field was bound as referenceFieldId. Filter / groupBy use the same tokens; CHOICE_SET_MULTIPLE filtering has special operator semantics — see references/records-query.md.

16. Answer with records query, not from memory. Counts, sums, filters, lookups — issue a fresh records query (or records list) and use the server's response. Do not reuse cached insert responses, IDs you generated earlier, or values from previous tool results. Exception: the Id returned by the same records insert you just made.

17. records query filters. Body shape, operators, per-type support, response, and unsupported-operator handling are in the filter contract. Symbol-form operators only (==/Equals/like → 400). On an unsupported operator/type or a missing value, don't run it — ask the user (Rule 18). Return all fields by default — omit selectedFields unless a subset is requested.

18. When a request isn't supported OR the upstream system returns an error, stop and confirm with the user — never silently substitute. Triggers (not exhaustive): a filter operator unsupported for the field type / not in the symbol list / missing a value (see filter contract → Unsupported operator); an unknown fieldName; a nonexistent or federated entity; a missing CLI verb (removeFields, … — see Not Supported); cross-entity joins or value forms the API can't serve; ANY 4xx/5xx, validation error, RESERVED_LANGUAGE_KEYWORDS, constraint-violation, or quota response from the API. Sequence: (1) surface the full upstream message verbatim — never swallow it; (2) state precisely what isn't supported or what failed (cite the rule / schema / error code); (3) propose a concrete next step keyed to the error — e.g. unknown fieldName → list the entity's real same-type fields from entities get and ask which; RESERVED_LANGUAGE_KEYWORDS → suggest a domain-specific rename; constraint violation → show the allowed range; missing dependency → list candidates via entities list / choice-sets list and offer pick-or-create (Rule 13); (4) apply only what the user approves, never your own fallback. If nothing works, error out and recommend the right sibling skill (uipath-maestro-flow / uipath-platform / uipath-rpa / uipath-agents / uipath-test) — don't fabricate or return a degraded result.

Tool Version Requirements

Upgrade with uip tools install @uipath/data-fabric-tool@latest when a feature appears to silently no-op (e.g. aggregate body keys returning raw record lists).

Quick Start

# List entities (use --native-only before any write)
uip df entities list --native-only --output json

# Get entity schema (field names and types)
uip df entities get <entity-id> --output json

# List records (first page)
uip df records list <entity-id> --limit 50 --output json

# Insert one record
uip df records insert <entity-id> --body '{"Name":"Alice","Score":95}' --output json

# Query with a filter
uip df records query <entity-id> \
  --body '{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"Status","operator":"=","value":"active"}]}}' \
  --output json

# Aggregate query — count of records per Status (server-side groupBy)
uip df records query <entity-id> \
  --body '{"selectedFields":["Status"],"groupBy":["Status"],"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}]}' \
  --output json

For Complex types field shapes and value formats, see references/entity-schema.md and references/records-query.md.

Task Navigation

Field Types

Pass the exact EntityFieldDataType string — the CLI is case-sensitive. Common types: STRING, INTEGER, DECIMAL, BOOLEAN, DATE, DATETIME, UUID, FILE, plus AUTO_NUMBER and the complex types (CHOICE_SET_* / RELATIONSHIP / FILE) whose required extras are covered in Rule 12. Full table with SQL backing types and value semantics in references/entity-schema.md.

Normalize user input to UPPERCASE before invoking. Users typically say boolean, string, decimal, datetime in their prompts. The CLI rejects lowercase / mixed-case variants with Cannot read properties of undefined (reading 'sqlTypeName'). Case-fold to the enum value: boolean → BOOLEAN, String → STRING, Decimal → DECIMAL, etc. Synonyms that don't map 1:1 (e.g. number → INTEGER or DECIMAL; text → STRING or MULTILINE_TEXT) need disambiguation — see references/entity-schema.md → Normalizing user-facing type names.

Advanced Field Constraints

Optional per-type constraints on create/update — lengthLimit (STRING, MULTILINE_TEXT), maxValue / minValue (INTEGER, BIG_INTEGER, DECIMAL, FLOAT, DOUBLE), decimalPrecision (DECIMAL, FLOAT, DOUBLE). See references/entity-schema.md for ranges and examples.

Workflow: Discover → Act → Verify

1. Discover — list entities, get schema, check existing records
2. Act — create/insert/update
3. Verify — re-read to confirm the operation succeeded

uip df entities list --native-only --output json
uip df entities get <entity-id> --output json
uip df records insert <entity-id> --body '{"Name":"Alice","Score":95}' --output json
uip df records list <entity-id> --limit 50 --output json
# Use HasNextPage + NextCursor to page through results
uip df records list <entity-id> --cursor <NextCursor> --output json

Query Request Format

Pass the query body via --body or --file; pagination uses --limit / --cursor / --offset CLI flags, never body keys (see Pagination below). The body shape, operators, per-type support, and response shape live in references/filter-platform-contract.md; query-only extras (selectedFields, sortOptions) are documented in references/records-query.md.

Pagination

records list / records query paginate via --limit, --cursor, --offset. See references/records-query.md.

Troubleshooting

Any error not in this table → Rule 18. (Surface verbatim, propose options keyed to the error, apply only what the user confirms.)

References

• references/entity-schema.md — Field definitions, supported types, schema update patterns, choice-set + relationship field shapes
• references/choice-sets.md — Full choice-set CRUD (list/list-values/create/update/delete plus choice-set-values create/update/delete), look up NumberIds, add CHOICE_SET fields to entities, write choice values on records
• references/records-query.md — Query filter syntax, pagination, sorting, choice/relationship semantics on read & write
• references/filter-platform-contract.md — Filter body structure, per-type operator support matrix, and what to do when a request needs an unsupported operator
• references/file-attachments.md — File field upload/download/delete file
• references/bulk-import.md — CSV format requirements and the Basic-fields-only limitation (complex types are silently dropped — use records insert with a JSON body instead)