yida-get-schema

Retrieve complete Yida form schema JSON with pages and componentsMap.

201|43|Updated Mar 5, 2026
One-click install
npx skills add https://github.com/openyida/openyida --skill yida-get-schema
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: yida-get-schema
Source: https://github.com/openyida/openyida/tree/main/yida-skills/skills/yida-get-schema
Command: npx skills add https://github.com/openyida/openyida --skill yida-get-schema

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many Yida workflows fail because field IDs (fieldId) are guessed or assumed from labels, causing data writes and queries to target the wrong fields. This Skill provides a reliable, authoritative way to fetch a form's full Schema so callers always use correct fieldId values and avoid silent data corruption.

Core Features & Use Cases

  • Retrieve the complete form Schema JSON including pages and componentsMap to discover exact fieldId values.
  • Enforce best practices: never guess fieldId, cache mappings to .cache/<project>-schema.json, and validate data writes by sampling a saved record.
  • Commonly used before data entry/update operations, when configuring query/search fields, setting process field permissions, or embedding fieldId constants in custom pages.

Quick Start

Run openyida get-schema <appType> <formUuid> to print the form's full schema JSON and confirm each fieldId.

Frequently Asked Questions about yida-get-schema

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I get the exact fieldId for a form in Yida low-code apps?

Retrieve the complete form schema to confirm exact fieldId values using the openyida get-schema command. It outputs the full pages and componentsMap JSON for a given appType and formUuid, ensuring accurate data writes and queries.

Why do my Yida form data writes and queries target the wrong fields?

Yida workflows fail when fieldId values are guessed or assumed from labels. Fetching the authoritative form schema prevents silent data corruption by returning the exact fieldId references needed for data entry, updates, and query filters.

How do I find form field IDs before configuring flow permissions in Yida?

Retrieve the full form schema JSON to discover exact fieldId values before setting process field permissions. Run get-schema with the correct appType and formUuid to output the complete pages and componentsMap structure.

Can I save the Yida form schema output to a file instead of printing it?

The form schema retrieval supports redirecting output to a file. Best practices suggest caching the mappings to a .cache/<project>-schema.json file to maintain correct fieldId references for custom page development and data operations.

What do I need to retrieve a Yida form schema successfully?

Retrieving the Yida form schema requires an authenticated session and correct identifiers, specifically the appType and formUuid. These inputs generate the complete pages and componentsMap JSON containing every fieldId.

Should I validate Yida data writes after fetching the form schema?

Validating data writes by sampling a saved record is a recommended best practice. After retrieving the schema and caching the fieldId mappings, confirm that your operations target the correct fields and avoid silent data corruption.