Cómo obtener el esquema de un modelo mediante API

La API de FacturaScripts, además de listar, crear, modificar y eliminar registros de modelos, también permite obtener el esquema de la tabla. Para ello simplemente hay que usar el identificador schema después del endpoint.

Ejemplo

En este ejemplo obtendremos el esquema de la tabla del modelo Familia.

http://localhost:8000/api/3/familias/schema

La API nos devolverá la lista de campos de la tabla:

{
	"codfamilia": {
		"type": "varchar(8)",
		"default": null,
		"is_nullable": "NO"
	},
	"codsubcuentacom": {
		"type": "varchar(15)",
		"default": null,
		"is_nullable": "YES"
	},
	"codsubcuentairpfcom": {
		"type": "varchar(15)",
		"default": null,
		"is_nullable": "YES"
	},
	"codsubcuentaven": {
		"type": "varchar(15)",
		"default": null,
		"is_nullable": "YES"
	},
	"descripcion": {
		"type": "varchar(100)",
		"default": null,
		"is_nullable": "NO"
	},
	"madre": {
		"type": "varchar(8)",
		"default": null,
		"is_nullable": "YES"
	},
	"numproductos": {
		"type": "int(11)",
		"default": "0",
		"is_nullable": "NO"
	}
}

Para cada campo se indican tres datos:

type: el tipo de dato de la columna en la base de datos (varía según el motor, por ejemplo varchar(100) o int(11)).
default: el valor por defecto de la columna, o null si no tiene.
is_nullable: NO si el campo es obligatorio (no admite nulos) o YES si puede quedar vacío.

Es una forma rápida de saber qué campos acepta un recurso y cuáles son obligatorios antes de crear o modificar registros. Los campos que estén ocultos en la API no aparecen en el esquema.