Saltar al contenido principal

Constructor del portal

El constructor del portal del workspace: el borrador, las versiones publicadas y el tema. list devuelve el estado completo (incluida la revision que protege el guardado), draft update reemplaza todo el borrador y publish create lo pone en el aire como una versión nueva. Los comandos tools editan el borrador por partes — una página, un bloque, un campo — y son los mismos que usa el chat con IA del constructor.

Borrador, publicación y tema​

ComandoHTTPDescripción
builder listGET /v1/builderConsultar el constructor del portal
builder draft updatePUT /v1/builder/draftGuardar el borrador del portal
builder og-image createPOST /v1/builder/og_imageSubir una imagen og:image
builder publish createPOST /v1/builder/publishPublicar el portal
builder secrets createPOST /v1/builder/secretsCifrar un secreto de bloque
builder theme updatePATCH /v1/builder/themeModificar los colores del tema del portal

Pruebas en el borrador​

Ejecutan de verdad la acción de un Botón de acción o de un Formulario del borrador, marcada como preview: true.

ComandoHTTPDescripción
builder action-runs createPOST /v1/builder/action_runsProbar un botón de acción del borrador
builder form-submissions createPOST /v1/builder/form_submissionsProbar un formulario del borrador

Versiones​

versions restore copia una versión al borrador sin tocar lo que está en el aire; versions rollback vuelve a poner la versión en el aire en el acto.

ComandoHTTPDescripción
builder versions getGET /v1/builder/versions/{number}Consultar una versión publicada
builder versions restorePOST /v1/builder/versions/{number}/restoreRestaurar una versión en el borrador
builder versions rollbackPOST /v1/builder/versions/{number}/rollbackVolver a poner una versión en el aire

Herramientas — páginas​

ComandoHTTPDescripción
builder tools create-page createPOST /v1/builder/tools/create_pageCrear una página
builder tools delete-page createPOST /v1/builder/tools/delete_pageEliminar una página
builder tools get-page listGET /v1/builder/tools/get_pageConsultar una página del borrador
builder tools list-pages listGET /v1/builder/tools/list_pagesListar las páginas del borrador
builder tools move-page createPOST /v1/builder/tools/move_pageMover una página en el menú
builder tools update-page createPOST /v1/builder/tools/update_pageModificar una página

Herramientas — bloques​

ComandoHTTPDescripción
builder tools describe-block-type listGET /v1/builder/tools/describe_block_typeDescribir un tipo de bloque
builder tools duplicate-block createPOST /v1/builder/tools/duplicate_blockDuplicar un bloque
builder tools insert-block createPOST /v1/builder/tools/insert_blockInsertar un bloque
builder tools list-actions listGET /v1/builder/tools/list_actionsListar las acciones del botón
builder tools list-block-types listGET /v1/builder/tools/list_block_typesListar los tipos de bloque
builder tools move-block createPOST /v1/builder/tools/move_blockMover un bloque
builder tools remove-block createPOST /v1/builder/tools/remove_blockQuitar un bloque
builder tools update-block createPOST /v1/builder/tools/update_blockModificar un bloque

Herramientas — tema, archivos y entidades​

ComandoHTTPDescripción
builder tools get-theme listGET /v1/builder/tools/get_themeConsultar los colores del tema
builder tools preview-portal-user-mapping listGET /v1/builder/tools/preview_portal_user_mappingPrevisualizar el mapeo de usuarios del portal
builder tools read-asset listGET /v1/builder/tools/read_assetLeer el contenido de un archivo
builder tools register-entity createPOST /v1/builder/tools/register_entityRegistrar una entidad desde una fuente de datos
builder tools rename-entity-fields createPOST /v1/builder/tools/rename_entity_fieldsRenombrar los campos de una entidad
builder tools save-computed-field createPOST /v1/builder/tools/save_computed_fieldGuardar un campo calculado

Ejemplos​

--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.

# Consultar el constructor del portal
kobana dashboards builder list --fields "draft,live_version,versions"

# Listar las páginas del borrador
kobana dashboards builder tools list-pages list

# Crear una página
kobana dashboards builder tools create-page create \
--json '{"name": "Faturas", "template": "list", "entity": "faturas"}'

# Insertar un bloque
kobana dashboards builder tools insert-block create \
--json '{"page_id": "PAGE_ID", "type": "Text", "props": {"text": "Bem-vindo!"}}'

# Publicar el portal
kobana dashboards builder publish create \
--json '{"revision": 12, "pages": [], "note": "Nova página de faturas"}' \
--dry-run

# Volver a poner una versión en el aire
kobana dashboards builder versions rollback --params '{"number": 3}' --dry-run

Próximos pasos​