Lista las entidades del modelo. Con ?format=tree las devuelve jerarquizadas, con flat en plano. Equivalente público de EntitiesManager/GetAllEntities.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio
• formatquery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/$BOARD_DB/schema/Entities" \
  -H "Authorization: Bearer $API_TOKEN"

Miembros de una entidad, paginados con skip/take y filtrables con searchString. Sólo lectura: para escribir miembros hay que ir por la API interna.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio
• namepath · obligatorio
• skipquery
• takequery
• searchStringquery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/$BOARD_DB/schema/Entities/{name}" \
  -H "Authorization: Bearer $API_TOKEN"

Lista los cubos del modelo. Devuelve la estructura, no los datos — los datos salen por una API Query.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/$BOARD_DB/schema/Cubes" \
  -H "Authorization: Bearer $API_TOKEN"

⭐ Ejecuta un procedure del data model y devuelve un sessionId. Es la pieza que la API interna no puede dar: /api/…/RunProcedure devuelve 204 sin ejecutar nada. Acepta la misma sintaxis de selección por query string que las queries, así que el procedure se lanza ya acotado a un periodo o a una entidad. Sólo procedures de data model — los de capsule no.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio
• procedureNamepath · obligatorio

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl -X POST "$BOARD_HOST/public/$BOARD_DB/procedure/Execute/{procedureName}" \
  -H "Authorization: Bearer $API_TOKEN"

Estado de una ejecución lanzada con Execute: {"status": 0|1, "message": "Stopped|Running"}. Se sondea en bucle hasta status=0. Es el sustituto del progreso que en la UI llega por SignalR.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio
• sessionIdpath · obligatorio

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/$BOARD_DB/procedure/Status/{sessionId}" \
  -H "Authorization: Bearer $API_TOKEN"

Árbol de una capsule o el listado completo. username permite verlo con los permisos de otro usuario.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• capsuleNamepath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/capsules/{capsuleName}" \
  -H "Authorization: Bearer $API_TOKEN"

Búsqueda de texto completo sobre el contenido de Board.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• textToSearchpath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/search/{textToSearch}" \
  -H "Authorization: Bearer $API_TOKEN"

Devuelve el resultado de una API Query como JSON. Es la única forma de sacar datos de un cubo por la API pública: la API no vuelca cubos arbitrarios, hay que definir antes la query en el modelo (por la API interna, ApiQueriesManager/AddNewApiQuery). Se filtra por query string con la sintaxis de selección de Board: ?year=2012, varias entidades en AND ?year=2012&city=IT01, lista en OR ?year=2012,2017, rango ?year=2015..2019. Con ?json=full repite las claves en cada registro en vez del formato compacto {columns, data}.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• dbNamepath · obligatorio
• queryNamepath · obligatorio
• jsonquery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/$BOARD_DB/query/{queryName}" \
  -H "Authorization: Bearer $API_TOKEN"

Devuelve una presentación por nombre.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• namepath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/presentations/{name}" \
  -H "Authorization: Bearer $API_TOKEN"

Devuelve un slide concreto de una presentación.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• namepath · obligatorio
• slideNamepath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/presentations/{name}/slides/{slideName}" \
  -H "Authorization: Bearer $API_TOKEN"

Lista los toolboxes de un slide.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• namepath · obligatorio
• slideNamepath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/presentations/{name}/slides/{slideName}/toolboxes" \
  -H "Authorization: Bearer $API_TOKEN"

Devuelve el contenido de un toolbox — datos incluidos, y acepta la misma sintaxis de filtrado por query string que las API Queries. Es la otra puerta por la que salen datos sin definir una query.

API pública REST de Board. Auth: OAuth2 client_credentials, scope public-api, contra /identity/connect/token.

Parámetros

• namepath · obligatorio
• slideNamepath · obligatorio
• toolboxNamepath · obligatorio
• usernamequery

Evidencia

La ruta responde 401 sin token (comprobado en vivo), pero nunca se ha llegado a llamar autenticada: falta crear el API Client. El token de sesión web no vale aunque conceda el scope.

Invocación

curl "$BOARD_HOST/public/presentations/{name}/slides/{slideName}/toolbox/{toolboxName}" \
  -H "Authorization: Bearer $API_TOKEN"

Lee el recurso del controlador. Exige dbName. Devuelve {listEntries}.

Análisis de impacto avanzado: qué objetos del modelo dependen de cuáles.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ listEntries }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/AdvImpactAnalysisManager/Get?dbName=$BOARD_DB"

Opera sobre disable log encryption. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración del motor de cálculo (Board Engine).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DisableLogEncryption`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/BEngConfigurator/DisableLogEncryption"

Opera sobre enable log encryption. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración del motor de cálculo (Board Engine).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EnableLogEncryption`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/BEngConfigurator/EnableLogEncryption"

Lee log configuration. Devuelve {diagnosticLogLevel, modes}.

Configuración del motor de cálculo (Board Engine).

Respuesta

{ diagnosticLogLevel, modes }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/BEngConfigurator/GetLogConfiguration"

Fija diagnostic verbosity level. Lleva cuerpo JSON. Devuelve un array de {name, value, fileName}.

Configuración del motor de cálculo (Board Engine).

Cuerpo

application/json

Respuesta

[ { name, value, fileName } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetDiagnosticVerbosityLevel`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/BEngConfigurator/SetDiagnosticVerbosityLevel"

Fija log mode list. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración del motor de cálculo (Board Engine).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetLogModeList`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/BEngConfigurator/SetLogModeList"

Fija log new password. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración del motor de cálculo (Board Engine).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetLogNewPassword`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/BEngConfigurator/SetLogNewPassword"

Aplica date selection. Exige fromTimestamp, toTimestamp, firstDayOfWeek. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Calendario asociado al rango temporal del modelo.

Parámetros

• fromTimestampquery · obligatorio
• toTimestampquery · obligatorio
• firstDayOfWeekquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ApplyDateSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Calendar/ApplyDateSelection?fromTimestamp=<fromTimestamp>&toTimestamp=<toTimestamp>&firstDayOfWeek=<firstDayOfWeek>"

Opera sobre entity day enabled for dbs. Lleva cuerpo JSON. Devuelve {cpsPath, screenId}.

Calendario asociado al rango temporal del modelo.

Cuerpo

application/json

Respuesta

{ cpsPath, screenId } — ScreenArgsDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EntityDayEnabledForDbs`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Calendar/EntityDayEnabledForDbs"

Aplica text analytics search. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Utilidades internas de recorte de cubos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ApplyTextAnalyticsSearch`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Cutiron/ApplyTextAnalyticsSearch"

Vacía screen selection. Lleva cuerpo JSON. Devuelve un array de {idx, name}.

Utilidades internas de recorte de cubos.

Cuerpo

application/json

Respuesta

[ { idx, name } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearScreenSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Cutiron/ClearScreenSelection"

Lee cubes. Exige dbName. Devuelve un array de {idx, name, entities}.

Utilidades internas de recorte de cubos.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { idx, name, entities } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Cutiron/GetCubes?dbName=$BOARD_DB"

Opera sobre backup database. Exige databaseName. Sin DTO de respuesta declarado.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• databaseNamequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/BackupDatabase?databaseName=$BOARD_DB"

Comprueba can manage database from tile. Exige dbName. Devuelve {hasAccess, needMigration, migrationType, isSecurityManager}.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ hasAccess, needMigration, migrationType, isSecurityManager }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/CheckCanManageDatabaseFromTile?dbName=$BOARD_DB"

Comprueba si el usuario en sesión tiene acceso a un modelo concreto. Útil antes de lanzar una cadena larga de escrituras.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/CheckDBAccess?dbName=$BOARD_DB"

Comprueba is profile manager. Exige dbName. Sin DTO de respuesta declarado.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Evidencia

Llamada en vivo → HTTP 500: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/CheckIsProfileManager?dbName=$BOARD_DB"

Opera sobre database restore list. Devuelve un array de {databaseName, restorePoint, folder, timeCreated}.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Respuesta

[ { databaseName, restorePoint, folder, timeCreated } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/DatabaseRestoreList"

⚠️ Borra el data model entero, con sus cubos, entidades y datos. Es un `GET`: basta pedir la URL. Sin confirmación y sin papelera.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { name, version, isLatestVersion } ]

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/DeleteDatabase?dbName=$BOARD_DB"

Lista los data models que el usuario en sesión puede abrir. Es la llamada con la que empieza cualquier script: da los nombres válidos para `dbName`.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/GetAvailableDatabases"

Devuelve el nombre del data model activo. Sirve de comprobación defensiva: ⚠️ con un `dbName` vacío o inexistente no da error, resuelve silenciosamente a otro modelo — esta llamada te dice sobre cuál estás actuando de verdad.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/GetDatabase?dbName=$BOARD_DB"

Definición completa de cada modelo: nombre, ruta en disco, tipo y flags. Más detalle que GetAvailableDatabases.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Respuesta

[ { name, version, isLatestVersion } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/GetDatabasesDefinitions"

Lee first available database. Sin DTO de respuesta declarado.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/GetFirstAvailableDatabase"

Lista los procedures del modelo. Equivalente a DatabaseProceduresManager/GetCoreProcedures.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• databasequery · obligatorio

Respuesta

[ { defaultDatabase, lastCapsuleUsed, lastScreenUsed, procedureType, name, description, deserializedDateTime } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/procedures.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/GetProcedures?database=$BOARD_DB"

Opera sobre migrate database. Exige dbName. Sin DTO de respuesta declarado.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/MigrateDatabase?dbName=$BOARD_DB"

Renombra database. Exige oldName, newName. Devuelve un array de {name, version, isLatestVersion}.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• oldNamequery · obligatorio
• newNamequery · obligatorio

Respuesta

[ { name, version, isLatestVersion } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/RenameDatabase?oldName=<oldName>&newName=<newName>"

Opera sobre restore database. Exige dbName, restorePoint. Sin DTO de respuesta declarado.

Data models: abrir, listar, comprobar acceso, borrar. ⚠️ Incluye DeleteDatabase.

Parámetros

• dbNamequery · obligatorio
• restorePointquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseManager/RestoreDatabase?dbName=$BOARD_DB&restorePoint=<restorePoint>"

Crea new dataset. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {id, title, description, creationUTC, lastEditUTC, owner, …}.

Datasets del data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { id, title, description, creationUTC, lastEditUTC, owner, aiAccess, isConfiguredLayout, arePendingChanges, databaseName, type, quickLayoutConfigurations } ] — LegacyDatasetDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddNewDataset`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatasetsManager/AddNewDataset?dbName=$BOARD_DB"

Cambia dataset type. Exige definitionId, database. Sin DTO de respuesta declarado.

Datasets del data model.

Parámetros

• definitionIdquery · obligatorio
• databasequery · obligatorio
• isFlexGridLayoutquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatasetsManager/ChangeDatasetType?definitionId=<definitionId>&database=$BOARD_DB"

Vacía dataset screen. Exige definitionId. Sin DTO de respuesta declarado.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Datasets del data model.

Parámetros

• definitionIdquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatasetsManager/ClearDatasetScreen?definitionId=<definitionId>"

Vacía dataset screen layout. Exige definitionId, database. Sin DTO de respuesta declarado.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Datasets del data model.

Parámetros

• definitionIdquery · obligatorio
• databasequery · obligatorio
• isFlexGridLayoutquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatasetsManager/ClearDatasetScreenLayout?definitionId=<definitionId>&database=$BOARD_DB"

Opera sobre clone dataset. Exige datasetId, dbName, name. Devuelve {id, title, description, creationUTC, lastEditUTC, owner, …}.

Datasets del data model.

Parámetros

• datasetIdpath · obligatorio
• dbNamequery · obligatorio
• namequery · obligatorio

Respuesta

{ id, title, description, creationUTC, lastEditUTC, owner, aiAccess, isConfiguredLayout, arePendingChanges, databaseName, type, quickLayoutConfigurations } — LegacyDatasetDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatasetsManager/CloneDataset/<datasetId>?dbName=$BOARD_DB&name=<name>"

Borra selected datasets. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Datasets del data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteSelectedDatasets`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatasetsManager/DeleteSelectedDatasets?dbName=$BOARD_DB"

Edita datasets. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {id, title, description, creationUTC, lastEditUTC, owner, …}.

Datasets del data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { id, title, description, creationUTC, lastEditUTC, owner, aiAccess, isConfiguredLayout, arePendingChanges, databaseName, type, quickLayoutConfigurations } ] — LegacyDatasetDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EditDatasets`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatasetsManager/EditDatasets?dbName=$BOARD_DB"

Comprueba si existe datasets. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Datasets del data model.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ExistsDatasets`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatasetsManager/ExistsDatasets"

Lee all datasets. Devuelve {datasets}.

Datasets del data model.

Respuesta

{ datasets }

Evidencia

Llamada en vivo → HTTP 403: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatasetsManager/GetAllDatasets"

Lee datasets. Exige dbName. Devuelve {datasets}.

Datasets del data model.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ datasets }

Evidencia

Llamada en vivo → HTTP 403: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatasetsManager/GetDatasets?dbName=$BOARD_DB"

Lee cubes for entity. Exige dbName, entityIdx. Devuelve un array de {cubeIdx, versionNumber, cubeName, extended, saturation, maxItemNr, …}.

Análisis de impacto: qué se rompe si cambias un objeto del modelo.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio

Respuesta

[ { cubeIdx, versionNumber, cubeName, extended, saturation, maxItemNr, entityIdx } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ImpactAnalysisManager/GetCubesForEntity?dbName=$BOARD_DB&entityIdx=<entityIdx>"

Lee impact analysis result for cube. Exige dbName, cubeIdx. Devuelve {sparsity, entities, screens, procedures, dataFlows, dataReaders, …}.

Análisis de impacto: qué se rompe si cambias un objeto del modelo.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio

Respuesta

{ sparsity, entities, screens, procedures, dataFlows, dataReaders, sparsities, rules }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ImpactAnalysisManager/GetImpactAnalysisResultForCube?dbName=$BOARD_DB&cubeIdx=<cubeIdx>"

Lee impact analysis result for entity. Exige dbName, entityIdx. Devuelve {sparsity, entities, screens, procedures, dataFlows, dataReaders, …}.

Análisis de impacto: qué se rompe si cambias un objeto del modelo.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio

Respuesta

{ sparsity, entities, screens, procedures, dataFlows, dataReaders, sparsities, rules }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ImpactAnalysisManager/GetImpactAnalysisResultForEntity?dbName=$BOARD_DB&entityIdx=<entityIdx>"

Lee sparsity for cube. Exige dbName, cubeName. Devuelve {name, description, sparsityType, maxItemNr, itemNr, densityPercent, …}.

Análisis de impacto: qué se rompe si cambias un objeto del modelo.

Parámetros

• dbNamequery · obligatorio
• cubeNamequery · obligatorio

Respuesta

{ name, description, sparsityType, maxItemNr, itemNr, densityPercent, sparsityIdx, entities, cubes, allDetails }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ImpactAnalysisManager/GetSparsityForCube?dbName=$BOARD_DB&cubeName=<cubeName>"

Opera sobre optimize single sparsity. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Análisis de impacto: qué se rompe si cambias un objeto del modelo.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action OptimizeSingleSparsity`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ImpactAnalysisManager/OptimizeSingleSparsity"

Crea table. Exige dbName. Lleva cuerpo JSON. Devuelve {uniqueId, name, type, fields}.

Acceso ROLAP a datos que no están cargados en memoria.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ uniqueId, name, type, fields }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CreateTable`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rolap/CreateTable?dbName=$BOARD_DB"

Borra table. Exige dbName, connectionName, tableName. Sin DTO de respuesta declarado.

Acceso ROLAP a datos que no están cargados en memoria.

Parámetros

• dbNamequery · obligatorio
• connectionNamequery · obligatorio
• tableNamequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rolap/DeleteTable?dbName=$BOARD_DB&connectionName=<connectionName>&tableName=<tableName>"

Lee protocol. Exige dbName. Lleva cuerpo JSON. Devuelve {manualMode, connectionName, where, query, dataTypeMode, joinSyntaxMode, …}.

Acceso ROLAP a datos que no están cargados en memoria.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ manualMode, connectionName, where, query, dataTypeMode, joinSyntaxMode, dateFormatMode, dateFormat, writeBackWhereMaxBufferSize, writeBackRecordUpdateMethod, mappings, join } — SqlProtocolDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetProtocol`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rolap/GetProtocol?dbName=$BOARD_DB"

Crea rule. Exige dbName. Lleva cuerpo JSON. Devuelve {record}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ record } — WebRuleAddRecordResult

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddRule`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/AddRule?dbName=$BOARD_DB"

Vacía rules. Exige dbName. Lleva cuerpo JSON. Devuelve {listRecords}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ listRecords } — WebRuleUpdateResult

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearRules`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/ClearRules?dbName=$BOARD_DB"

Borra rules. Exige dbName. Lleva cuerpo JSON. Devuelve {rulesIdxRemoved}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ rulesIdxRemoved } — WebRuleDeleteResult

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteRules`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/DeleteRules?dbName=$BOARD_DB"

Exporta el recurso del controlador. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {key, value}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { key, value } ] — WebRuleResultBase

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Export`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/Export?dbName=$BOARD_DB"

Lee elements by page. Exige dbName, entityIdx, pageNumber. Lleva cuerpo JSON. Devuelve un array de {idx, code, codeAndDesc, description, order}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio
• pageNumberquery · obligatorio

Cuerpo

application/json

Respuesta

[ { idx, code, codeAndDesc, description, order } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetElementsByPage`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/GetElementsByPage?dbName=$BOARD_DB&entityIdx=<entityIdx>&pageNumber=<pageNumber>"

Lee elements count. Exige dbName, entityIdx. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetElementsCount`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/GetElementsCount?dbName=$BOARD_DB&entityIdx=<entityIdx>"

Lee rules. Exige dbName. Devuelve {groups, records}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ groups, records } — WebRuleBase

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Rules/GetRules?dbName=$BOARD_DB"

Lee rules for dataflow. Exige databaseName. Devuelve un array de {ruleIdx, text}.

Reglas de negocio sobre el data model.

Parámetros

• databaseNamequery · obligatorio

Respuesta

[ { ruleIdx, text } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Rules/GetRulesForDataflow?databaseName=$BOARD_DB"

Importa el recurso del controlador. Lleva cuerpo JSON. Devuelve un array de {elementIdx, formula}.

Reglas de negocio sobre el data model.

Cuerpo

application/json

Respuesta

[ { elementIdx, formula } ] — WebRuleBase

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Import`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/Import"

Actualiza rules. Exige dbName. Lleva cuerpo JSON. Devuelve {listRecords}.

Reglas de negocio sobre el data model.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ listRecords } — WebRuleUpdateResult

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateRules`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Rules/UpdateRules?dbName=$BOARD_DB"

Lee snapshotter screen. Exige jobId. Devuelve {invokeUpdateLayouts}.

Snapshots de datos del modelo.

Parámetros

• jobIdquery · obligatorio

Respuesta

{ invokeUpdateLayouts }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Snapshot/GetSnapshotterScreen?jobId=<jobId>"

Opera sobre active maintenance mode. Exige dbName. Devuelve {message, outcome}.

Resumen del data model: objetos, tamaños, saturación.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ message, outcome }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Summary/ActiveMaintenanceMode?dbName=$BOARD_DB"

Cambia encryption password. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Resumen del data model: objetos, tamaños, saturación.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeEncryptionPassword`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Summary/ChangeEncryptionPassword"

Opera sobre deactive maintenance mode. Exige dbName. Devuelve {message, outcome}.

Resumen del data model: objetos, tamaños, saturación.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ message, outcome }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Summary/DeactiveMaintenanceMode?dbName=$BOARD_DB"

Opera sobre decrypt database. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Resumen del data model: objetos, tamaños, saturación.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DecryptDatabase`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Summary/DecryptDatabase"

Opera sobre encrypt database. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Resumen del data model: objetos, tamaños, saturación.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EncryptDatabase`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Summary/EncryptDatabase"

Resumen del modelo: cuántas entidades, cubos y relaciones tiene y cuánto ocupa. Buena llamada de sanidad tras una carga.

Resumen del data model: objetos, tamaños, saturación.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ isDatabaseInMaintenanceMode, rulesCount, totalCubeSize, isDBEncrypted, isDBLocked, isByokEnabled }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Summary/GetDatabaseSummaryInfo?dbName=$BOARD_DB"

Opera sobre unload database. Exige dbName. Sin DTO de respuesta declarado.

Resumen del data model: objetos, tamaños, saturación.

Parámetros

• dbNamequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Summary/UnloadDatabase?dbName=$BOARD_DB"

Opera sobre unlock database. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Resumen del data model: objetos, tamaños, saturación.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UnlockDatabase`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Summary/UnlockDatabase"

Vacía and update time range. Exige database. Lleva cuerpo JSON. Devuelve {yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, …}.

Rango temporal del modelo: años, meses, semanas, día, año fiscal. Crea el data model.

Parámetros

• databasequery · obligatorio

Cuerpo

application/json

Respuesta

{ yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, weekFirstDay, firstWeekOfTheYear, weekDescriptionAsWeekNumber, weekDescriptionAsDate, weekMask, isDayActive, isFiscalYearActive, fiscalYearBeginsOnMonth, fiscalYearMask, timeLanguage }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearAndUpdateTimeRange`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X PUT -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TimeRangeManager/ClearAndUpdateTimeRange?database=$BOARD_DB"

Crea un data model nuevo. El cuerpo es el rango temporal (`yearFrom`, `yearTo`, qué niveles se activan: trimestre, semana, día, año fiscal) — en Board el modelo *nace* con su eje de tiempo, no se añade después.

Rango temporal del modelo: años, meses, semanas, día, año fiscal. Crea el data model.

Parámetros

• databasequery · obligatorio

Cuerpo

application/json

Respuesta

{ yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, weekFirstDay, firstWeekOfTheYear, weekDescriptionAsWeekNumber, weekDescriptionAsDate, weekMask, isDayActive, isFiscalYearActive, fiscalYearBeginsOnMonth, fiscalYearMask, timeLanguage }

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TimeRangeManager/CreateDatabase?database=$BOARD_DB"

Lee el rango temporal de un modelo existente: años, niveles activos, máscaras de formato y primer día de la semana. Es lo que hay que copiar para clonar un modelo.

Rango temporal del modelo: años, meses, semanas, día, año fiscal. Crea el data model.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, weekFirstDay, firstWeekOfTheYear, weekDescriptionAsWeekNumber, weekDescriptionAsDate, weekMask, isDayActive, isFiscalYearActive, fiscalYearBeginsOnMonth, fiscalYearMask, timeLanguage }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/data-models.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TimeRangeManager/GetTimeRangeOptions?dbName=$BOARD_DB"

Actualiza time range. Exige database. Lleva cuerpo JSON. Devuelve {yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, …}.

Rango temporal del modelo: años, meses, semanas, día, año fiscal. Crea el data model.

Parámetros

• databasequery · obligatorio

Cuerpo

application/json

Respuesta

{ yearFrom, yearTo, isQuarterActive, isQuarterReferredToFiscalYear, quarterMask, isWeekActive, weekFirstDay, firstWeekOfTheYear, weekDescriptionAsWeekNumber, weekDescriptionAsDate, weekMask, isDayActive, isFiscalYearActive, fiscalYearBeginsOnMonth, fiscalYearMask, timeLanguage }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateTimeRange`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TimeRangeManager/UpdateTimeRange?database=$BOARD_DB"

Crea una entidad (una dimensión). En el cuerpo van el nombre, el ancho del código y el de la descripción. ⚠️ Los modelos antiguos pueden incumplir los límites que el API impone hoy.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ idx, name, assignedGroup, assignedPosition, itemNr, maxItemNr, isUnbalancedEntity, isTimeEntity, isTemporalEntity, tree, enabled, level, display, codeWidth, descWidth, physicalName, sortBy, customEntityMask, allowUserView, isRollupEntity, isCustomEntity, isReplica, isStandAlone, idxReplicated, exportName, isInUse, lessAgregates, childrenIdx }

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/AddEntity?dbName=$BOARD_DB"

Cambia entity group. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeEntityGroup`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ChangeEntityGroup?dbName=$BOARD_DB"

Vacía all entities. Exige dbName. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ClearAllEntities?dbName=$BOARD_DB"

Vacía entities. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearEntities`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ClearEntities?dbName=$BOARD_DB"

⚠️ Borra entidades y con ellas los datos de los cubos que las dimensionan.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/DeleteEntities?dbName=$BOARD_DB"

Vuelca los miembros de una entidad a fichero. La cara de lectura de UpdateMembers: sirve para copiar dimensiones de un modelo a otro.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ExtractEntities?dbName=$BOARD_DB"

Vuelca la jerarquía poblada (qué miembro cuelga de cuál), no sólo la lista plana de miembros.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ExtractEntitiesTree?dbName=$BOARD_DB"

Filtra element list. Exige dbName, entityIdx, lastSearchRow, searchPattern. Devuelve {lastSearchRow, elementList}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio
• lastSearchRowquery · obligatorio
• searchPatternquery · obligatorio

Respuesta

{ lastSearchRow, elementList }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/FilterElementList?dbName=$BOARD_DB&entityIdx=<entityIdx>&lastSearchRow=<lastSearchRow>&searchPattern=<searchPattern>"

Lista todas las entidades del modelo con su `entityIdx`, ancho de código y descripción, y su saturación. El `entityIdx` es la clave que piden casi todas las demás llamadas de entidades.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/GetAllEntities?dbName=$BOARD_DB"

Lee all entities saturation. Exige dbName. Devuelve un array de {entityIdx, maxItemNr, itemNr, freePercentage}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { entityIdx, maxItemNr, itemNr, freePercentage } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/GetAllEntitiesSaturation?dbName=$BOARD_DB"

Lee element list. Exige dbName, entityIdx, page. Devuelve un array de {idx, code, codeAndDesc, description, order}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio
• pagequery · obligatorio

Respuesta

[ { idx, code, codeAndDesc, description, order } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/GetElementList?dbName=$BOARD_DB&entityIdx=<entityIdx>&page=<page>"

Lee entities and groups localization. Exige dbName. Devuelve {entities, groups}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ entities, groups }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/GetEntitiesAndGroupsLocalization?dbName=$BOARD_DB"

Lee normal user view entities new. Exige dbName. Devuelve un array de {name}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { name } ] — WebEntityInfo

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/GetNormalUserViewEntitiesNew?dbName=$BOARD_DB"

Comprueba si entity contained in empty cubes. Exige dbName, entityIdx. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EntitiesManager/IsEntityContainedInEmptyCubes?dbName=$BOARD_DB&entityIdx=<entityIdx>"

Reordena entity group position new. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ReorderEntityGroupPositionNew`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ReorderEntityGroupPositionNew?dbName=$BOARD_DB"

Reordena entity position new. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ReorderEntityPositionNew`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ReorderEntityPositionNew?dbName=$BOARD_DB"

Replica entities. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {idx, name, assignedGroup, assignedPosition, itemNr, maxItemNr, …}.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { idx, name, assignedGroup, assignedPosition, itemNr, maxItemNr, isUnbalancedEntity, isTimeEntity, isTemporalEntity, tree, enabled, level, display, codeWidth, descWidth, physicalName, sortBy, customEntityMask, allowUserView, isRollupEntity, isCustomEntity, isReplica, isStandAlone, idxReplicated, exportName, isInUse, lessAgregates, childrenIdx } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ReplicateEntities`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/ReplicateEntities?dbName=$BOARD_DB"

Fija custom member order. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Entidades: las dimensiones del modelo y sus miembros.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetCustomMemberOrder`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/SetCustomMemberOrder"

Modifica entidades existentes (nombre, anchos, grupo).

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { idx, name, assignedGroup, assignedPosition, itemNr, maxItemNr, isUnbalancedEntity, isTimeEntity, isTemporalEntity, tree, enabled, level, display, codeWidth, descWidth, physicalName, sortBy, customEntityMask, allowUserView, isRollupEntity, isCustomEntity, isReplica, isStandAlone, idxReplicated, exportName, isInUse, lessAgregates, childrenIdx } ]

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/UpdateEntities?dbName=$BOARD_DB"

Da de alta o modifica los miembros de una entidad (`entityIdx` en la query, la lista en el cuerpo). Es la única forma directa de escribir en el modelo sin data reader y sin sesión de pantalla — pero sólo escribe miembros, nunca valores de cubo.

Entidades: las dimensiones del modelo y sus miembros.

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/entidades.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EntitiesManager/UpdateMembers?dbName=$BOARD_DB&entityIdx=<entityIdx>"

Cambia relation. Lleva cuerpo JSON. Devuelve un array de {name, idx, webLevel, corrupted, duplicated, isEmpty, …}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Respuesta

[ { name, idx, webLevel, corrupted, duplicated, isEmpty, isOverloaded, total, isDefaultTemporal, isUnbalanced, items } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeRelation`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/ChangeRelation"

Cambia unbalanced element parent. Exige databaseName, entityIdx, elementIdx, parentIdx. Devuelve {reason, elements}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio
• elementIdxquery · obligatorio
• parentIdxquery · obligatorio

Respuesta

{ reason, elements } — WebUnbalanceElement

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/ChangeUnbalancedElementParent?databaseName=$BOARD_DB&entityIdx=<entityIdx>&elementIdx=<elementIdx>&parentIdx=<parentIdx>"

Opera sobre default action. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DefaultAction`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/DefaultAction"

Crea o modifica una relación entre dos entidades — es decir, declara la jerarquía (Día → Semana, Producto → Familia). Define la estructura; no rellena qué cuelga de qué.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Respuesta

[ { name, idx, webLevel, corrupted, duplicated, isEmpty, isOverloaded, total, isDefaultTemporal, isUnbalanced, items } ]

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/relaciones.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/EditRelation"

Filtra select member elements. Exige databaseName, entityIdx, filterText, lastSearchIndex. Lleva cuerpo JSON. Devuelve {lastSearchRow, elementList}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio
• filterTextquery · obligatorio
• lastSearchIndexquery · obligatorio

Cuerpo

application/json

Respuesta

{ lastSearchRow, elementList }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FilterSelectMemberElements`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/FilterSelectMemberElements?databaseName=$BOARD_DB&entityIdx=<entityIdx>&filterText=<filterText>&lastSearchIndex=<lastSearchIndex>"

Filtra unbalanced elements no client filters. Exige databaseName, entityIdx. Lleva cuerpo JSON. Devuelve un array de {parentIdx, hasChildren, unbalancedSetting, idx, code, desc, …}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio

Cuerpo

application/json

Respuesta

[ { parentIdx, hasChildren, unbalancedSetting, idx, code, desc, isActive, isSelected } ] — WebUnbalanceElement

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FilterUnbalancedElementsNoClientFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/FilterUnbalancedElementsNoClientFilters?databaseName=$BOARD_DB&entityIdx=<entityIdx>"

Opera sobre fix relations. Exige dbName, isTemporal. Sin DTO de respuesta declarado.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• dbNamequery · obligatorio
• isTemporalquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/FixRelations?dbName=$BOARD_DB&isTemporal=<isTemporal>"

Lee normalization paths. Exige database. Devuelve un array de {lessIdx, lessName, moreIdx, moreName, implicitIdx, canExecute, …}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databasequery · obligatorio

Respuesta

[ { lessIdx, lessName, moreIdx, moreName, implicitIdx, canExecute, paths } ] — ElementSearchDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/GetNormalizationPaths?database=$BOARD_DB"

Lee relation members. Exige database, fromIdx, toIdx, skip, take, onlyMissing, filter. Devuelve {total, anyMissing, data}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databasequery · obligatorio
• fromIdxquery · obligatorio
• toIdxquery · obligatorio
• skipquery · obligatorio
• takequery · obligatorio
• onlyMissingquery · obligatorio
• filterquery · obligatorio

Respuesta

{ total, anyMissing, data }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/GetRelationMembers?database=$BOARD_DB&fromIdx=<fromIdx>&toIdx=<toIdx>&skip=<skip>&take=<take>&onlyMissing=<onlyMissing>&filter=<filter>"

Lee select member elements. Exige dbName, entityIdx, page. Lleva cuerpo JSON. Devuelve un array de {idx, code, desc, isActive, isSelected}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• dbNamequery · obligatorio
• entityIdxquery · obligatorio
• pagequery · obligatorio

Cuerpo

application/json

Respuesta

[ { idx, code, desc, isActive, isSelected } ] — ElementModel

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetSelectMemberElements`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/GetSelectMemberElements?dbName=$BOARD_DB&entityIdx=<entityIdx>&page=<page>"

Lee unbalanced elements children. Exige databaseName, entityIdx, parentIdxs, depth. Devuelve un array de {parentIdx, hasChildren, unbalancedSetting, idx, code, desc, …}.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio
• parentIdxsquery · obligatorio
• depthquery · obligatorio

Respuesta

[ { parentIdx, hasChildren, unbalancedSetting, idx, code, desc, isActive, isSelected } ] — WebUnbalanceElement

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/GetUnbalancedElementsChildren?databaseName=$BOARD_DB&entityIdx=<entityIdx>&parentIdxs=<parentIdxs>&depth=<depth>"

Opera sobre normalization exe. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action NormalizationExe`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/NormalizationExe"

Opera sobre normalization save. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action NormalizationSave`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/NormalizationSave"

Recorre una relación y devuelve sus elementos. Es como se lee una jerarquía ya poblada.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Parámetros

• databasequery · obligatorio

Respuesta

{ bottomUpScan, topDownScan }

Evidencia

Cuerpo JSON, enums y trampas documentados en docs/actions/relaciones.md.

Receta completa: docs/actions/relaciones.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Relationships/Scan?database=$BOARD_DB"

Puebla la relación: dice qué miembro padre corresponde a cada miembro hijo. Sin esta llamada la jerarquía existe pero está vacía y las agregaciones dan cero.

Relaciones entre entidades: las jerarquías (Producto → Familia → Línea).

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/relaciones.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Relationships/SetRelatedElements"

Exporta taxonomy. Exige id. Sin DTO de respuesta declarado.

Taxonomías de clasificación (ficheros).

Parámetros

• idpath · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Taxonomy/ExportTaxonomy/<id>"

Lee child of tuple. Exige taxTagTuple. Sin DTO de respuesta declarado.

Taxonomías de clasificación (ficheros).

Parámetros

• taxTagTuplequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Taxonomy/GetChildOfTuple?taxTagTuple=<taxTagTuple>"

Lee file in folder. Devuelve un array de {id, fileName, taxonomyId, taxonomyName}.

Taxonomías de clasificación (ficheros).

Respuesta

[ { id, fileName, taxonomyId, taxonomyName } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Taxonomy/GetFileInFolder"

Lee link structure from file. Exige id. Devuelve un array de {id, parentId, name, isLeaf, isTuple, boardXbrlTag}.

Taxonomías de clasificación (ficheros).

Parámetros

• idpath · obligatorio

Respuesta

[ { id, parentId, name, isLeaf, isTuple, boardXbrlTag } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Taxonomy/GetLinkStructureFromFile/<id>"

Crea entry point configuration. Lleva cuerpo JSON. Devuelve {id, name, desc, taxonomyFileId, taxonomyName}.

Gestión de taxonomías.

Cuerpo

application/json

Respuesta

{ id, name, desc, taxonomyFileId, taxonomyName }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddEntryPointConfiguration`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TaxonomyManager/AddEntryPointConfiguration"

Opera sobre are there loaded taxonomies. Sin DTO de respuesta declarado.

Gestión de taxonomías.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TaxonomyManager/AreThereLoadedTaxonomies"

Borra entry point configurations. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Gestión de taxonomías.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteEntryPointConfigurations`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TaxonomyManager/DeleteEntryPointConfigurations"

Lee taxonomies. Devuelve un array de {id, name, desc, taxonomyFileId, taxonomyName}.

Gestión de taxonomías.

Respuesta

[ { id, name, desc, taxonomyFileId, taxonomyName } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TaxonomyManager/GetTaxonomies"

Actualiza entry point configurations. Lleva cuerpo JSON. Devuelve un array de {id, name, desc, taxonomyFileId, taxonomyName}.

Gestión de taxonomías.

Cuerpo

application/json

Respuesta

[ { id, name, desc, taxonomyFileId, taxonomyName } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateEntryPointConfigurations`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TaxonomyManager/UpdateEntryPointConfigurations"

Filtra unbalanced elements web filters. Lleva cuerpo JSON. Devuelve {filtersDto, elements}.

Elementos de jerarquías no balanceadas.

Cuerpo

application/json

Respuesta

{ filtersDto, elements }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FilterUnbalancedElementsWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/UnbalancedHierarchyElements/FilterUnbalancedElementsWebFilters"

Lee ato entities configurator unbalanced elements. Exige databaseName, entityIdx, parentIdx, depth, appendSelections, selectExpandedElements. Lleva cuerpo JSON. Devuelve un array de {parentIdx, hasChildren, unbalancedSetting}.

Elementos de jerarquías no balanceadas.

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio
• parentIdxquery · obligatorio
• depthquery · obligatorio
• appendSelectionsquery · obligatorio
• selectExpandedElementsquery · obligatorio

Cuerpo

application/json

Respuesta

[ { parentIdx, hasChildren, unbalancedSetting } ] — UnbalancedElementDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetAtoEntitiesConfiguratorUnbalancedElements`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/UnbalancedHierarchyElements/GetAtoEntitiesConfiguratorUnbalancedElements?databaseName=$BOARD_DB&entityIdx=<entityIdx>&parentIdx=<parentIdx>&depth=<depth>&appendSelections=<appendSelections>&selectExpandedElements=<selectExpandedElements>"

Lee unbalanced elements. Exige databaseName, entityIdx, parentIdx, depth, appendSelections, selectExpandedElements. Lleva cuerpo JSON. Devuelve un array de {parentIdx, hasChildren, unbalancedSetting}.

Elementos de jerarquías no balanceadas.

Parámetros

• databaseNamequery · obligatorio
• entityIdxquery · obligatorio
• parentIdxquery · obligatorio
• depthquery · obligatorio
• appendSelectionsquery · obligatorio
• selectExpandedElementsquery · obligatorio

Cuerpo

application/json

Respuesta

[ { parentIdx, hasChildren, unbalancedSetting } ] — UnbalancedElementDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetUnbalancedElements`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/UnbalancedHierarchyElements/GetUnbalancedElements?databaseName=$BOARD_DB&entityIdx=<entityIdx>&parentIdx=<parentIdx>&depth=<depth>&appendSelections=<appendSelections>&selectExpandedElements=<selectExpandedElements>"

Lee unbalanced elements web filters. Lleva cuerpo JSON. Devuelve {filtersDto, elements}.

Elementos de jerarquías no balanceadas.

Cuerpo

application/json

Respuesta

{ filtersDto, elements }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetUnbalancedElementsWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/UnbalancedHierarchyElements/GetUnbalancedElementsWebFilters"

Crea un cubo. El cuerpo lleva el nombre, el tipo de dato y las entidades que lo dimensionan. ⚠️ Hay que llamar antes a ComputeDims: el API espera las dimensiones ya calculadas.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } — WebCube

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/cubos.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/AddCube?dbName=$BOARD_DB"

Crea version. Exige dbName, cubeName. Lleva cuerpo JSON. Devuelve {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } — WebCube

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddVersion`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/AddVersion?dbName=$BOARD_DB&cubeName=<cubeName>"

Alinea cube version. Exige dbName, cubeIdx, version. Sin DTO de respuesta declarado.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio
• versionquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/AlignCubeVersion?dbName=$BOARD_DB&cubeIdx=<cubeIdx>&version=<version>"

Cambia cube group. Exige dbName. Lleva cuerpo JSON. Devuelve {cubes, groups}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ cubes, groups }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeCubeGroup`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ChangeCubeGroup?dbName=$BOARD_DB"

Vacía all cubes. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } ] — WebCube

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearAllCubes`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ClearAllCubes?dbName=$BOARD_DB"

Vacía all cube versions. Exige dbName, cubeName. Devuelve {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeNamequery · obligatorio

Respuesta

{ name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } — WebCube

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/ClearAllCubeVersions?dbName=$BOARD_DB&cubeName=<cubeName>"

Vacía cubes. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } ] — WebCube

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearCubes`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ClearCubes?dbName=$BOARD_DB"

Calcula las dimensiones de un cubo a partir de la lista de entidades: cuántas celdas ocupa y qué densidad tiene. Paso obligatorio antes de AddCube.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { entityIdx, sparsity } ]

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/cubos.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ComputeDims?dbName=$BOARD_DB"

Copia cube structure and versions. Exige dbName, cubeIdx. Devuelve {dataType, versions}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio

Respuesta

{ dataType, versions }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/CopyCubeStructureAndVersions?dbName=$BOARD_DB&cubeIdx=<cubeIdx>"

⚠️ Borra cubos con sus datos.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/cubos.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/DeleteCubes?dbName=$BOARD_DB"

Borra cube version. Exige dbName, cubeIdx, versionNumber. Devuelve {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio
• versionNumberquery · obligatorio

Respuesta

{ name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } — WebCube

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/DeleteCubeVersion?dbName=$BOARD_DB&cubeIdx=<cubeIdx>&versionNumber=<versionNumber>"

Edita version. Exige dbName, cubeName. Lleva cuerpo JSON. Devuelve {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } — WebCube

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EditVersion`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/EditVersion?dbName=$BOARD_DB&cubeName=<cubeName>"

Lista los cubos del modelo con su nombre físico (`V0068`), su nombre visible, el tipo de dato, las versiones y por qué entidades está dimensionado. Con `loadSize=false` es rápida; el tamaño se pide aparte.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• loadSizequery · obligatorio

Respuesta

{ cubes, groups }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/cubos.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/GetAllCubes?dbName=$BOARD_DB&loadSize=<loadSize>"

Tamaño en disco de cada cubo. Es la forma de saber qué cubos están vacíos antes de intentar copiarlos.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/cubos.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/GetAllCubesSize?dbName=$BOARD_DB"

Nombres traducidos de cubos y grupos de cubos.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ cubes, groups }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/GetCubesAndGroupsLocalization?dbName=$BOARD_DB"

Lee temporal entity. Exige dbName, cubeIdx. Devuelve {temporalEntityIdx, structure, temporalEntityDescription, elements}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio

Respuesta

{ temporalEntityIdx, structure, temporalEntityDescription, elements }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/GetTemporalEntity?dbName=$BOARD_DB&cubeIdx=<cubeIdx>"

Reordena cube group position new. Exige dbName. Lleva cuerpo JSON. Devuelve {cubes, groups}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ cubes, groups }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ReorderCubeGroupPositionNew`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ReorderCubeGroupPositionNew?dbName=$BOARD_DB"

Reordena cube position new. Exige dbName. Lleva cuerpo JSON. Devuelve {cubes, groups}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ cubes, groups }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ReorderCubePositionNew`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/ReorderCubePositionNew?dbName=$BOARD_DB"

Actualiza cubes. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {name, fileSize, fileSizeNumber, extended, type, isRubberCube, …}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { name, fileSize, fileSizeNumber, extended, type, isRubberCube, versions, databaseType, dataType, blobExtension, mxcEntityIdx, cubeTextSubGroup, maxItemNumber, sparsity, saturation, isCopiedCube, exclude, inRam, versionList } ] — WebCube

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateCubes`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CubesManager/UpdateCubes?dbName=$BOARD_DB"

Opera sobre verify cube. Exige dbName, cubeIdx. Devuelve un array de {version, checksum}.

Cubos del data model: crear, listar, dimensionar, versionar, medir tamaño.

Parámetros

• dbNamequery · obligatorio
• cubeIdxquery · obligatorio

Respuesta

[ { version, checksum } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CubesManager/VerifyCube?dbName=$BOARD_DB&cubeIdx=<cubeIdx>"

Lee export presentation action roots. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/GetExportPresentationActionRoots"

Lee scenarios and clusterings dtos. Exige dbName. Devuelve {forecasting, clustering}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ forecasting, clustering }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/GetScenariosAndClusteringsDtos?dbName=$BOARD_DB"

Lista los comandos de servidor disponibles para un step ServerCommand (`actionType` 28) — los `.bat`/`.exe` que Board puede lanzar en su propia máquina.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { path, fileName } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/GetServerSideCommands?dbName=$BOARD_DB"

Lee user selection result. Exige dbName, maxElementsToProcess. Lleva cuerpo JSON. Devuelve un array de {entityIdx, totalElementCount, requestedElementList}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• dbNamequery · obligatorio
• maxElementsToProcessquery · obligatorio

Cuerpo

application/json

Respuesta

[ { entityIdx, totalElementCount, requestedElementList } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetUserSelectionResult`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/GetUserSelectionResult?dbName=$BOARD_DB&maxElementsToProcess=<maxElementsToProcess>"

Pega steps. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action PasteSteps`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/PasteSteps"

Opera sobre procedure get block args. Exige path, procedureName, procedureTypeDto, actionGuid, areNotSavedItems, useVirtualCubes. Devuelve un array de {actionId, blocks}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• pathquery · obligatorio
• procedureNamequery · obligatorio
• procedureTypeDtoquery · obligatorio
• actionGuidquery · obligatorio
• areNotSavedItemsquery · obligatorio
• useVirtualCubesquery · obligatorio

Respuesta

[ { actionId, blocks } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/ProcedureGetBlockArgs?path=$BOARD_DB&procedureName=<procedureName>&procedureTypeDto=<procedureTypeDto>&actionGuid=<actionGuid>&areNotSavedItems=<areNotSavedItems>&useVirtualCubes=<useVirtualCubes>"

Opera sobre procedure get block args for tuple xbrl. Exige path, procedureName, procedureTypeDto, actionGuid, areNotSavedItems, actionTypeDto. Devuelve {taxTagTuple, blockArgs}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• pathquery · obligatorio
• procedureNamequery · obligatorio
• procedureTypeDtoquery · obligatorio
• actionGuidquery · obligatorio
• areNotSavedItemsquery · obligatorio
• actionTypeDtoquery · obligatorio

Respuesta

{ taxTagTuple, blockArgs }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/ProcedureGetBlockArgsForTupleXbrl?path=$BOARD_DB&procedureName=<procedureName>&procedureTypeDto=<procedureTypeDto>&actionGuid=<actionGuid>&areNotSavedItems=<areNotSavedItems>&actionTypeDto=<actionTypeDto>"

Opera sobre procedure get entities and blocks. Exige path, procedureName, procedureTypeDto, actionGuid, areNotSavedItems. Devuelve {entities, blocks}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• pathquery · obligatorio
• procedureNamequery · obligatorio
• procedureTypeDtoquery · obligatorio
• actionGuidquery · obligatorio
• areNotSavedItemsquery · obligatorio

Respuesta

{ entities, blocks }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/ProcedureGetEntitiesAndBlocks?path=$BOARD_DB&procedureName=<procedureName>&procedureTypeDto=<procedureTypeDto>&actionGuid=<actionGuid>&areNotSavedItems=<areNotSavedItems>"

Opera sobre procedure get entities for outer join. Exige path, procedureName, procedureTypeDto, actionGuid, areNotSavedItems. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• pathquery · obligatorio
• procedureNamequery · obligatorio
• procedureTypeDtoquery · obligatorio
• actionGuidquery · obligatorio
• areNotSavedItemsquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/ProcedureGetEntitiesForOuterJoin?path=$BOARD_DB&procedureName=<procedureName>&procedureTypeDto=<procedureTypeDto>&actionGuid=<actionGuid>&areNotSavedItems=<areNotSavedItems>"

Opera sobre procedure get entities for outer join multiple layouts. Exige path, procedureName, procedureTypeDto, actionGuid. Devuelve un array de {layoutId, outerJoinIdx}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• pathquery · obligatorio
• procedureNamequery · obligatorio
• procedureTypeDtoquery · obligatorio
• actionGuidquery · obligatorio

Respuesta

[ { layoutId, outerJoinIdx } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ActionConfigurator/ProcedureGetEntitiesForOuterJoinMultipleLayouts?path=$BOARD_DB&procedureName=<procedureName>&procedureTypeDto=<procedureTypeDto>&actionGuid=<actionGuid>"

Guarda tmp procedure selection. Exige dbName. Lleva cuerpo JSON. Devuelve {description}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ description }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveTmpProcedureSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/SaveTmpProcedureSelection?dbName=$BOARD_DB"

Prueba call rest api step. Lleva cuerpo JSON. Devuelve {status, httpStatusCode, rawBodyResponse, rawHeaderResponse, rawBodyRequest, rawHeaderRequest, …}.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Cuerpo

application/json

Respuesta

{ status, httpStatusCode, rawBodyResponse, rawHeaderResponse, rawBodyRequest, rawHeaderRequest, urlRequest, data, errorMessage }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action TestCallRestApiStep`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/TestCallRestApiStep"

Prueba r connection. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action TestRConnection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/TestRConnection"

Actualiza configured data flow layout. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateConfiguredDataFlowLayout`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/UpdateConfiguredDataFlowLayout"

Actualiza configured layout. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Configuración de los steps de un procedure y de las acciones que se disparan desde objetos de screen.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateConfiguredLayout`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ActionConfigurator/UpdateConfiguredLayout"

Crea or update procedures. Exige path. Lleva cuerpo JSON. Devuelve un array de {procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList}.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Respuesta

[ { procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } ] — ProcedureDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddOrUpdateProcedures`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/AddOrUpdateProcedures?path=$BOARD_DB"

Opera sobre clean all procedure break points. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CleanAllProcedureBreakPoints`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/CleanAllProcedureBreakPoints"

Borra procedures. Exige path. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteProcedures`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/DeleteProcedures?path=$BOARD_DB"

Lee core procedures. Exige path. Devuelve un array de {id, oldDescription, name, description, procedureType, defaultDatabase}.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Parámetros

• pathquery · obligatorio

Respuesta

[ { id, oldDescription, name, description, procedureType, defaultDatabase } ] — CoreProcedureDto

Evidencia

Cuerpo JSON, enums y trampas documentados en docs/actions/procedures.md.

Receta completa: docs/actions/procedures.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleProceduresManager/GetCoreProcedures?path=$BOARD_DB"

Lee procedures. Exige path. Lleva cuerpo JSON. Devuelve un array de {procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList}.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Respuesta

[ { procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } ] — ProcedureDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetProcedures`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/GetProcedures?path=$BOARD_DB"

Opera sobre procedure save as. Exige path, sourceProcedure, name. Devuelve {procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList}.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Parámetros

• pathquery · obligatorio
• sourceProcedurequery · obligatorio
• namequery · obligatorio

Respuesta

{ procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } — ProcedureDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/ProcedureSaveAs?path=$BOARD_DB&sourceProcedure=<sourceProcedure>&name=<name>"

Alterna procedure break points. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Procedures que viven dentro de una capsule (path = ruta de la capsule).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ToggleProcedureBreakPoints`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleProceduresManager/ToggleProcedureBreakPoints"

Crea o reemplaza procedures. El cuerpo es el procedure entero (no un parche): grupos, steps y `virtualCubesList`. `oldDescription` es el nombre anterior — así se renombran.

Procedures a nivel de data model (path = nombre del modelo).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Respuesta

[ { procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } ] — ProcedureDto

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/procedures.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/AddOrUpdateProcedures?path=$BOARD_DB"

Opera sobre clean all procedure break points. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Procedures a nivel de data model (path = nombre del modelo).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CleanAllProcedureBreakPoints`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/CleanAllProcedureBreakPoints"

⚠️ Borra procedures por GUID.

Procedures a nivel de data model (path = nombre del modelo).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteProcedures`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/DeleteProcedures?path=$BOARD_DB"

Lista los procedures del modelo. ⚠️ Devuelve `name` = GUID y `description` = el nombre que ves en pantalla; todas las demás llamadas piden el GUID.

Procedures a nivel de data model (path = nombre del modelo).

Parámetros

• pathquery · obligatorio

Respuesta

[ { id, oldDescription, name, description, procedureType, defaultDatabase } ] — CoreProcedureDto

Evidencia

Cuerpo JSON, enums y trampas documentados en docs/actions/procedures.md.

Receta completa: docs/actions/procedures.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DatabaseProceduresManager/GetCoreProcedures?path=$BOARD_DB"

Lee la definición completa de uno o varios procedures, step a step, con sus `actionType`, selecciones, layouts y ficheros. Es un `POST` pese al nombre; el cuerpo es un array de GUIDs. La pieza clave para automatizar: se lee un procedure real y se reescribe.

Procedures a nivel de data model (path = nombre del modelo).

Parámetros

• pathquery · obligatorio

Cuerpo

application/json

Respuesta

[ { procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } ] — ProcedureDto

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/procedures.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/GetProcedures?path=$BOARD_DB"

Opera sobre procedure save as. Exige path, sourceProcedure, name. Devuelve {procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList}.

Procedures a nivel de data model (path = nombre del modelo).

Parámetros

• pathquery · obligatorio
• sourceProcedurequery · obligatorio
• namequery · obligatorio

Respuesta

{ procedureBehaviour, procedureWindowEnum, procedureGroups, virtualCubesList } — ProcedureDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/ProcedureSaveAs?path=$BOARD_DB&sourceProcedure=<sourceProcedure>&name=<name>"

Alterna procedure break points. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Procedures a nivel de data model (path = nombre del modelo).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ToggleProcedureBreakPoints`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DatabaseProceduresManager/ToggleProcedureBreakPoints"

Opera sobre failed dto. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FailedDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/FailedDto"

Lee block args. Exige layoutId, actionGuid. Devuelve un array de {actionId, blocks}.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Parámetros

• layoutIdquery · obligatorio
• actionGuidquery · obligatorio

Respuesta

[ { actionId, blocks } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Procedures/GetBlockArgs?layoutId=<layoutId>&actionGuid=<actionGuid>"

Elimina message. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RemoveMessage`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RemoveMessage"

Elimina messages. Sin DTO de respuesta declarado.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Procedures/RemoveMessages"

Opera sobre resume dto. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ResumeDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/ResumeDto"

Ejecuta broadcast procedure step. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunBroadcastProcedureStep`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunBroadcastProcedureStep"

Ejecuta clickable action. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunClickableAction`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunClickableAction"

Ejecuta click action. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunClickAction`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunClickAction"

Ejecuta data entry trigger. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunDataEntryTrigger`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunDataEntryTrigger"

Ejecuta data entry trigger by coordinates. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunDataEntryTriggerByCoordinates`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunDataEntryTriggerByCoordinates"

Ejecuta export presentation action. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunExportPresentationAction`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunExportPresentationAction"

Ejecuta refreshable dto. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunRefreshableDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/RunRefreshableDto"

Arranca task check. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Procedures/StartTaskCheck"

Detiene task check. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Procedures/StopTaskCheck"

Actualiza procedure selection. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateProcedureSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/UpdateProcedureSelection"

Actualiza procedure selection range. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Sesión de ejecución interactiva de un procedure (arrancar, reanudar, abortar).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateProcedureSelectionRange`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Procedures/UpdateProcedureSelectionRange"

Lee capsule core procedures. Exige path. Devuelve un array de {name, description, procedureType, defaultDatabase, lastScreenUsed, deserializedDateTime}.

Procedures accesibles desde el toolbox de una screen.

Parámetros

• pathquery · obligatorio

Respuesta

[ { name, description, procedureType, defaultDatabase, lastScreenUsed, deserializedDateTime } ] — ToolboxCoreProcedureDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ToolboxProcedures/GetCapsuleCoreProcedures?path=$BOARD_DB"

Lee database core procedures. Exige database. Devuelve un array de {name, description, procedureType, defaultDatabase, lastScreenUsed, deserializedDateTime}.

Procedures accesibles desde el toolbox de una screen.

Parámetros

• databasequery · obligatorio

Respuesta

[ { name, description, procedureType, defaultDatabase, lastScreenUsed, deserializedDateTime } ] — ToolboxCoreProcedureDto

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ToolboxProcedures/GetDatabaseCoreProcedures?database=$BOARD_DB"

Lee data sources. Devuelve un array de {authenticationType, apiBaseUrl, timeout, apiKeyAuthConfiguration, basicAuthConfiguration, oAuth2Configuration, …}.

Data sources de tipo API REST para los data readers.

Respuesta

[ { authenticationType, apiBaseUrl, timeout, apiKeyAuthConfiguration, basicAuthConfiguration, oAuth2Configuration, certificateFileName, certificatePassword } ] — ApiDataSourceDto

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ApiDataSource/GetDataSources"

Guarda api file. Sin DTO de respuesta declarado.

Data sources de tipo API REST para los data readers.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ApiDataSource/SaveApiFile"

Lee data sources. Devuelve un array de {blobContainerName, clientId, clientSecret, cluster, resourceGroupName, subscriptionId, …}.

Conexión a Azure ML como origen de datos.

Respuesta

[ { blobContainerName, clientId, clientSecret, cluster, resourceGroupName, subscriptionId, tenantId, virtualMachineSize, workspaceName } ] — AzureMLDataSourceDto

Evidencia

Llamada en vivo → HTTP 419: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/AzureMLDataSource/GetDataSources"

Lee vm sizes. Lleva cuerpo JSON. Devuelve un array de {name, family, cpuCount, gpuCount, memory, isPremiumIO, …}.

Conexión a Azure ML como origen de datos.

Cuerpo

application/json

Respuesta

[ { name, family, cpuCount, gpuCount, memory, isPremiumIO, lowPriorityCapable, osVhdSizeMB, maxResourceVolumeMB, computeTypes } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetVMSizes`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/AzureMLDataSource/GetVMSizes"

Calcula etl. Lleva cuerpo JSON. Devuelve un array de {entityType, formula, value}.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Cuerpo

application/json

Respuesta

[ { entityType, formula, value } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ComputeEtl`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataReaderManager/ComputeEtl"

⚠️ Borra data readers del modelo.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/data-readers.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataReaderManager/DeleteProtocols?dbName=$BOARD_DB"

Lee protocol. Exige dbName, type, idx. Devuelve {idx, name, assignedGroup, manageEntityItemsSort, etlFormulas}.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Parámetros

• dbNamequery · obligatorio
• typequery · obligatorio
• idxquery · obligatorio

Respuesta

{ idx, name, assignedGroup, manageEntityItemsSort, etlFormulas } — DataReaderProtocolDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DataReaderManager/GetProtocol?dbName=$BOARD_DB&type=<type>&idx=<idx>"

Lista los data readers del modelo con su última ejecución: fecha, filas leídas, errores. Es la forma de comprobar si una carga funcionó cuando no hay navegador que muestre el progreso.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Parámetros

• dbNamequery · obligatorio
• addAllquery · obligatorio

Respuesta

{ protocols, textFileDataSourceRepositories, availableSqlConnections, availableSapConnections }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/data-readers.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DataReaderManager/GetProtocolsTable?dbName=$BOARD_DB&addAll=<addAll>"

Guarda as protocol. Exige dbName. Lleva cuerpo JSON. Devuelve {idx, type, name, assignedGroup, hasEtlFormulas, manageEntityItemsSort, …}.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ idx, type, name, assignedGroup, hasEtlFormulas, manageEntityItemsSort, source, fileEditable, textFilePath, textFilePattern, textFileSelectedPath, log, onErrorStop, lastDate, elapsed, validRec, discRec, isLocal }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveAsProtocol`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataReaderManager/SaveAsProtocol?dbName=$BOARD_DB"

Actualiza protocol. Exige dbName. Lleva cuerpo JSON. Devuelve {idx, type, name, assignedGroup, hasEtlFormulas, manageEntityItemsSort, …}.

Protocolos de carga: la tabla de data readers del modelo y su ejecución.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ idx, type, name, assignedGroup, hasEtlFormulas, manageEntityItemsSort, source, fileEditable, textFilePath, textFilePattern, textFileSelectedPath, log, onErrorStop, lastDate, elapsed, validRec, discRec, isLocal }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateProtocol`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataReaderManager/UpdateProtocol?dbName=$BOARD_DB"

Crea data source. Lleva cuerpo JSON. Devuelve {uniqueId, name}.

Definiciones genéricas de conexión a orígenes de datos.

Cuerpo

application/json

Respuesta

{ uniqueId, name } — DataSourceDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddDataSource`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataSource/AddDataSource"

Borra el recurso del controlador. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Definiciones genéricas de conexión a orígenes de datos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Delete`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataSource/Delete"

Lee saved data sources. Exige typesFilter. Devuelve un array de {uniqueId, name}.

Definiciones genéricas de conexión a orígenes de datos.

Parámetros

• typesFilterquery · obligatorio

Respuesta

[ { uniqueId, name } ] — DataSourceDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DataSource/GetSavedDataSources?typesFilter=<typesFilter>"

Prueba data source connection. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Definiciones genéricas de conexión a orígenes de datos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action TestDataSourceConnection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataSource/TestDataSourceConnection"

Actualiza data sources. Lleva cuerpo JSON. Devuelve un array de {uniqueId, name}.

Definiciones genéricas de conexión a orígenes de datos.

Cuerpo

application/json

Respuesta

[ { uniqueId, name } ] — DataSourceDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateDataSources`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/DataSource/UpdateDataSources"

Opera sobre activate. Lleva cuerpo JSON. Devuelve {status}.

Indicadores económicos externos como origen de datos.

Cuerpo

application/json

Respuesta

{ status }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Activate`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X PUT -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EconomicIndicators/Activate"

Opera sobre deactivate. Lleva cuerpo JSON. Devuelve {status}.

Indicadores económicos externos como origen de datos.

Cuerpo

application/json

Respuesta

{ status }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Deactivate`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X PUT -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EconomicIndicators/Deactivate"

Lee indicator data. Exige db, provider, providerId, frequency. Devuelve {id, frequency, dataItems}.

Indicadores económicos externos como origen de datos.

Parámetros

• dbquery · obligatorio
• providerquery · obligatorio
• providerIdquery · obligatorio
• frequencyquery · obligatorio

Respuesta

{ id, frequency, dataItems }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EconomicIndicators/GetIndicatorData?db=<db>&provider=<provider>&providerId=<providerId>&frequency=<frequency>"

Lee workbench. Exige db, workbenchId. Devuelve {id, name, description, dataModel_YearFrom, dataModel_YearTo, alertsConfiguration, …}.

Indicadores económicos externos como origen de datos.

Parámetros

• dbquery · obligatorio
• workbenchIdquery · obligatorio

Respuesta

{ id, name, description, dataModel_YearFrom, dataModel_YearTo, alertsConfiguration, indicators }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EconomicIndicators/GetWorkbench?db=<db>&workbenchId=<workbenchId>"

Lee workbench list. Exige db. Devuelve un array de {id, industry, numberOfIndicators, description}.

Indicadores económicos externos como origen de datos.

Parámetros

• dbquery · obligatorio

Respuesta

[ { id, industry, numberOfIndicators, description } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/EconomicIndicators/GetWorkbenchList?db=<db>"

Actualiza alert configuration. Lleva cuerpo JSON.

Indicadores económicos externos como origen de datos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateAlertConfiguration`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EconomicIndicators/UpdateAlertConfiguration"

Actualiza data. Lleva cuerpo JSON. Devuelve {success, indicatorId, isActive, name, alertActionProcedureId}.

Indicadores económicos externos como origen de datos.

Cuerpo

application/json

Respuesta

{ success, indicatorId, isActive, name, alertActionProcedureId }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateData`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/EconomicIndicators/UpdateData"

Opera sobre browse sap. Exige dbName. Lleva cuerpo JSON. Devuelve {headers, values}.

Data reader contra SAP.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ headers, values }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action BrowseSap`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SapDataReader/BrowseSap?dbName=$BOARD_DB"

Guarda protocol. Exige dbName. Lleva cuerpo JSON. Devuelve {source, protocolInfo}.

Data reader contra SAP.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ source, protocolInfo }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveProtocol`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SapDataReader/SaveProtocol?dbName=$BOARD_DB"

Lee available extractors. Exige dbName, connectionUrl, sapDataSourceName. Devuelve un array de {type, typeExtended, name, created, lastChange, lastRun}.

Conexión a SAP.

Parámetros

• dbNamequery · obligatorio
• connectionUrlquery · obligatorio
• sapDataSourceNamequery · obligatorio

Respuesta

[ { type, typeExtended, name, created, lastChange, lastRun } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SapDataSource/GetAvailableExtractors?dbName=$BOARD_DB&connectionUrl=<connectionUrl>&sapDataSourceName=<sapDataSourceName>"

Lee extractor model. Exige dbName, connectionUrl, extractorName, sapDataSourceName. Devuelve {baseUrl, fields}.

Conexión a SAP.

Parámetros

• dbNamequery · obligatorio
• connectionUrlquery · obligatorio
• extractorNamequery · obligatorio
• sapDataSourceNamequery · obligatorio

Respuesta

{ baseUrl, fields }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SapDataSource/GetExtractorModel?dbName=$BOARD_DB&connectionUrl=<connectionUrl>&extractorName=<extractorName>&sapDataSourceName=<sapDataSourceName>"

Guarda sap file. Sin DTO de respuesta declarado.

Conexión a SAP.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SapDataSource/SaveSapFile"

Ejecuta sql query. Exige dbName. Lleva cuerpo JSON. Devuelve {headers, values}.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ headers, values }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ExecuteSqlQuery`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SqlDataReader/ExecuteSqlQuery?dbName=$BOARD_DB"

Lee rdb table fields. Exige dbName, connectionName, tableUniqueId. Devuelve un array de {uniqueId, name, size, sampleValue, typeKey, typeDescription}.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Parámetros

• dbNamequery · obligatorio
• connectionNamequery · obligatorio
• tableUniqueIdquery · obligatorio

Respuesta

[ { uniqueId, name, size, sampleValue, typeKey, typeDescription } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataReader/GetRdbTableFields?dbName=$BOARD_DB&connectionName=<connectionName>&tableUniqueId=<tableUniqueId>"

Lee rdb tables. Exige dbName, connectionName. Lleva cuerpo JSON. Devuelve un array de {uniqueId, name, type, fields}.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Parámetros

• dbNamequery · obligatorio
• connectionNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { uniqueId, name, type, fields } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetRdbTables`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SqlDataReader/GetRdbTables?dbName=$BOARD_DB&connectionName=<connectionName>"

Lee rdb tables and fields. Exige dbName, connectionName, filter. Devuelve un array de {uniqueId, name, type, fields}.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Parámetros

• dbNamequery · obligatorio
• connectionNamequery · obligatorio
• filterquery · obligatorio

Respuesta

[ { uniqueId, name, type, fields } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataReader/GetRdbTablesAndFields?dbName=$BOARD_DB&connectionName=<connectionName>&filter=<filter>"

Lee sql log messages. Sin DTO de respuesta declarado.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Evidencia

Llamada en vivo → HTTP 500: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataReader/GetSqlLogMessages"

Guarda protocol. Exige dbName. Lleva cuerpo JSON. Devuelve {source, protocolInfo}.

Data reader SQL: la consulta y el mapeo a cubos y entidades.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ source, protocolInfo }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveProtocol`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SqlDataReader/SaveProtocol?dbName=$BOARD_DB"

Opera sobre build connection string. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Conexiones SQL (ODBC / OLE DB).

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action BuildConnectionString`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SqlDataSource/BuildConnectionString"

Enumera los DSN ODBC registrados en la máquina del servidor de Board.

Conexiones SQL (ODBC / OLE DB).

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/GetAvailableOdbc"

Lista las conexiones SQL definidas (ODBC/OLE DB) para usarlas en un data reader.

Conexiones SQL (ODBC / OLE DB).

Respuesta

[ { dialect, queryTimeout, disableRecordCounting, connectionString, username, password } ] — SqlDataSourceDto

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/GetDataSources"

Lee fields values. Exige providerName, uniqueId, connectionString. Devuelve un array de {propertyDisplayName, value}.

Conexiones SQL (ODBC / OLE DB).

Parámetros

• providerNamequery · obligatorio
• uniqueIdquery · obligatorio
• connectionStringquery · obligatorio

Respuesta

[ { propertyDisplayName, value } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/GetFieldsValues?providerName=<providerName>&uniqueId=<uniqueId>&connectionString=<connectionString>"

Lee ole db providers. Devuelve un array de {name, type, description}.

Conexiones SQL (ODBC / OLE DB).

Respuesta

[ { name, type, description } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/GetOleDbProviders"

Lee provider info. Exige uniqueId, type, providerName, connectionString. Devuelve {connectionString, properties, values}.

Conexiones SQL (ODBC / OLE DB).

Parámetros

• uniqueIdquery · obligatorio
• typequery · obligatorio
• providerNamequery · obligatorio
• connectionStringquery · obligatorio

Respuesta

{ connectionString, properties, values }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/GetProviderInfo?uniqueId=<uniqueId>&type=<type>&providerName=<providerName>&connectionString=<connectionString>"

Prueba connection. Exige uniqueId, connectionString, username, password, connectionTimeOut. Sin DTO de respuesta declarado.

Conexiones SQL (ODBC / OLE DB).

Parámetros

• uniqueIdquery · obligatorio
• connectionStringquery · obligatorio
• usernamequery · obligatorio
• passwordquery · obligatorio
• connectionTimeOutquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SqlDataSource/TestConnection?uniqueId=<uniqueId>&connectionString=<connectionString>&username=<username>&password=<password>&connectionTimeOut=<connectionTimeOut>"

Lee csv preconfigured fields cloud file. Exige dbName, path, file, encoding, cloudStorageId, cloudDataSourceType. Devuelve {delimiter, firstRowContainsHeader}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• encodingquery · obligatorio
• cloudStorageIdquery · obligatorio
• cloudDataSourceTypequery · obligatorio

Respuesta

{ delimiter, firstRowContainsHeader } — TextFileCsvPreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetCsvPreconfiguredFieldsCloudFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&encoding=<encoding>&cloudStorageId=<cloudStorageId>&cloudDataSourceType=<cloudDataSourceType>"

Lee las primeras filas de un CSV del servidor y propone el mapeo de columnas. Se usa antes de SaveProtocol para no escribir el mapeo a ciegas.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• encodingquery · obligatorio

Respuesta

{ delimiter, firstRowContainsHeader } — TextFileCsvPreConfiguredFieldsResponseDto

Evidencia

Cuerpo JSON, enums y trampas documentados en docs/actions/data-readers.md.

Receta completa: docs/actions/data-readers.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetCsvPreconfiguredFieldsLocalFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&encoding=<encoding>"

Lee csv row preview cloud file. Exige dbName, path, file, rowIndexZeroBased, encoding, delimiter, hasHeader, cloudStorageId, cloudDataSourceType. Devuelve {headers, values}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• encodingquery · obligatorio
• delimiterquery · obligatorio
• hasHeaderquery · obligatorio
• cloudStorageIdquery · obligatorio
• cloudDataSourceTypequery · obligatorio

Respuesta

{ headers, values } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetCsvRowPreviewCloudFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&rowIndexZeroBased=<rowIndexZeroBased>&encoding=<encoding>&delimiter=<delimiter>&hasHeader=<hasHeader>&cloudStorageId=<cloudStorageId>&cloudDataSourceType=<cloudDataSourceType>"

Lee csv row preview http file. Exige dbName, url, rowIndexZeroBased, rowsNeeded, encoding, delimiter, hasHeader. Devuelve {headers, values}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• urlquery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• rowsNeededquery · obligatorio
• encodingquery · obligatorio
• delimiterquery · obligatorio
• hasHeaderquery · obligatorio

Respuesta

{ headers, values } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetCsvRowPreviewHttpFile?dbName=$BOARD_DB&url=<url>&rowIndexZeroBased=<rowIndexZeroBased>&rowsNeeded=<rowsNeeded>&encoding=<encoding>&delimiter=<delimiter>&hasHeader=<hasHeader>"

Lee csv row preview local file. Exige dbName, path, file, rowIndexZeroBased, rowsNeeded, encoding, delimiter, hasHeader. Devuelve {headers, values}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• rowsNeededquery · obligatorio
• encodingquery · obligatorio
• delimiterquery · obligatorio
• hasHeaderquery · obligatorio

Respuesta

{ headers, values } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetCsvRowPreviewLocalFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&rowIndexZeroBased=<rowIndexZeroBased>&rowsNeeded=<rowsNeeded>&encoding=<encoding>&delimiter=<delimiter>&hasHeader=<hasHeader>"

Lee fixed width preconfigured fields cloud file. Exige dbName, path, file, encoding, cloudStorageId, cloudDataSourceType. Devuelve {mappings}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• encodingquery · obligatorio
• cloudStorageIdquery · obligatorio
• cloudDataSourceTypequery · obligatorio

Respuesta

{ mappings } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetFixedWidthPreconfiguredFieldsCloudFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&encoding=<encoding>&cloudStorageId=<cloudStorageId>&cloudDataSourceType=<cloudDataSourceType>"

Lee fixed width preconfigured fields local file. Exige dbName, path, file, encoding. Devuelve {mappings}.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• encodingquery · obligatorio

Respuesta

{ mappings } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetFixedWidthPreconfiguredFieldsLocalFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&encoding=<encoding>"

Lee fixed width row preview cloud file. Exige dbName, path, file, rowIndexZeroBased, encoding, cloudStorageId, cloudDataSourceType. Sin DTO de respuesta declarado.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• encodingquery · obligatorio
• cloudStorageIdquery · obligatorio
• cloudDataSourceTypequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetFixedWidthRowPreviewCloudFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&rowIndexZeroBased=<rowIndexZeroBased>&encoding=<encoding>&cloudStorageId=<cloudStorageId>&cloudDataSourceType=<cloudDataSourceType>"

Lee fixed width row preview http file. Exige dbName, url, rowIndexZeroBased, encoding. Sin DTO de respuesta declarado.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• urlquery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• encodingquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetFixedWidthRowPreviewHttpFile?dbName=$BOARD_DB&url=<url>&rowIndexZeroBased=<rowIndexZeroBased>&encoding=<encoding>"

Lee fixed width row preview local file. Exige dbName, path, file, rowIndexZeroBased, encoding. Sin DTO de respuesta declarado.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• filequery · obligatorio
• rowIndexZeroBasedquery · obligatorio
• encodingquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataReader/GetFixedWidthRowPreviewLocalFile?dbName=$BOARD_DB&path=$BOARD_DB&file=<file>&rowIndexZeroBased=<rowIndexZeroBased>&encoding=<encoding>"

Crea o modifica un data reader de fichero de texto/CSV: ruta del fichero, separador, codificación y el mapeo de cada columna a una entidad o a un cubo. Es la vía natural para meter datos en cubos sin navegador.

Data reader de ficheros de texto/CSV: el protocolo y su mapeo.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

{ respository, protocolInfo } — TextFilePreConfiguredFieldsResponseDto

Evidencia

Ejecutada en vivo contra la instalación, con efecto comprobado sobre el modelo.

Receta completa: docs/actions/data-readers.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/TextFileDataReader/SaveProtocol?dbName=$BOARD_DB"

Codificaciones aceptadas al leer ficheros de texto. Importa: un CSV en ANSI leído como UTF-8 rompe los acentos de los miembros.

Conexiones a ficheros de texto/CSV.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataSource/GetAvailableEncodings"

Lee repository. Exige dbName, path, pattern. Devuelve {path, pattern, files}.

Conexiones a ficheros de texto/CSV.

Parámetros

• dbNamequery · obligatorio
• pathquery · obligatorio
• patternquery · obligatorio

Respuesta

{ path, pattern, files }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataSource/GetRepository?dbName=$BOARD_DB&path=$BOARD_DB&pattern=<pattern>"

Lee tree text file. Exige selectedDatasourceId, selectedDataSourceType, dbName, path, pattern. Devuelve un array de {id, name, completeName, isFolder, childrenNodes}.

Conexiones a ficheros de texto/CSV.

Parámetros

• selectedDatasourceIdquery · obligatorio
• selectedDataSourceTypequery · obligatorio
• dbNamequery · obligatorio
• pathquery · obligatorio
• patternquery · obligatorio

Respuesta

[ { id, name, completeName, isFolder, childrenNodes } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/TextFileDataSource/GetTreeTextFile?selectedDatasourceId=<selectedDatasourceId>&selectedDataSourceType=<selectedDataSourceType>&dbName=$BOARD_DB&path=$BOARD_DB&pattern=<pattern>"

Opera sobre custom fonts. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleFontFamily/CustomFonts"

Borra font. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/CapsuleFontFamily/DeleteFont"

Descarga arial black font. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleFontFamily/DownloadArialBlackFont"

Descarga corporate font. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleFontFamily/DownloadCorporateFont"

Lee size capsule font. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Llamada en vivo → HTTP 400: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleFontFamily/GetSizeCapsuleFont"

Comprueba si font configured. Sin DTO de respuesta declarado.

Tipografías de las capsules.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/CapsuleFontFamily/IsFontConfigured"

Cambia tile rating. Exige capsulePath. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeTileRating`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/ChangeTileRating?capsulePath=<capsulePath>"

Lee available screens. Exige capsulePath. Devuelve un array de {id, name}.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Respuesta

[ { id, name } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/GetAvailableScreens?capsulePath=<capsulePath>"

Árbol de capsules y carpetas: la lista de aplicaciones publicadas.

El árbol de capsules: carpetas, capsules y sus screens.

Respuesta

{ name, path, lastOpenedDate, rating, hasIcon, hasLabel, isPinned, isFolder, securityAccess, items }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/GetCapsules"

Screens de una capsule. Da los `screenId` que piden las acciones de runtime.

El árbol de capsules: carpetas, capsules y sus screens.

Respuesta

[ { id, name, parentId, type, canBeRead, errorMessage } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/GetCapsulesAvailableScreens"

Lee capsule screen list. Exige path. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• pathquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/GetCapsuleScreenList?path=$BOARD_DB"

Lee flattened. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/GetFlattened"

Lee tiles models. Lleva cuerpo JSON. Devuelve un array de {path, icon, prebuiltIcon, background, executionResult}.

El árbol de capsules: carpetas, capsules y sus screens.

Cuerpo

application/json

Respuesta

[ { path, icon, prebuiltIcon, background, executionResult } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetTilesModels`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/GetTilesModels"

Comprueba si editing mode protected. Exige capsulePath. Devuelve {capsulePath, isProtected, movedCapsulePath, userCanAccessDesignMode}.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Respuesta

{ capsulePath, isProtected, movedCapsulePath, userCanAccessDesignMode }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/IsEditingModeProtected?capsulePath=<capsulePath>"

Comprueba si password protected. Exige capsulePath. Devuelve {capsulePath, isProtected, movedCapsulePath}.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Respuesta

{ capsulePath, isProtected, movedCapsulePath }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/IsPasswordProtected?capsulePath=<capsulePath>"

Comprueba si play mode protected. Exige capsulePath. Devuelve {capsulePath, isProtected, movedCapsulePath}.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Respuesta

{ capsulePath, isProtected, movedCapsulePath }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Capsules/IsPlayModeProtected?capsulePath=<capsulePath>"

Opera sobre migrate capsule. Exige capsulePath. Lleva cuerpo JSON. Devuelve {newCapsulePath, unhandledException, cannotSave, success, missingDatabases, screensToRepair, …}.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio

Cuerpo

application/json

Respuesta

{ newCapsulePath, unhandledException, cannotSave, success, missingDatabases, screensToRepair, missingScreens, missingReportingOptions }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action MigrateCapsule`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/MigrateCapsule?capsulePath=<capsulePath>"

Guarda properties. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveProperties`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/SaveProperties"

Fija favorite. Exige capsulePath, isFavorite. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio
• isFavoritequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/SetFavorite?capsulePath=<capsulePath>&isFavorite=<isFavorite>"

Valida editing password. Exige capsulePath, storePassword. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio
• storePasswordquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ValidateEditingPassword`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/ValidateEditingPassword?capsulePath=<capsulePath>&storePassword=<storePassword>"

Valida open password. Exige capsulePath, storePassword. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

El árbol de capsules: carpetas, capsules y sus screens.

Parámetros

• capsulePathquery · obligatorio
• storePasswordquery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ValidateOpenPassword`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Capsules/ValidateOpenPassword?capsulePath=<capsulePath>&storePassword=<storePassword>"

Opera sobre {id}. Exige id, version. Sin DTO de respuesta declarado.

Chat integrado en el cliente web.

Parámetros

• idpath · obligatorio
• versionpath · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/<id>/avatar/<version>"

Opera sobre chats. Devuelve un array de {id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, …}.

Chat integrado en el cliente web.

Respuesta

[ { id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, imageUrl, recipientId, username } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/Chats"

Opera sobre chat users. Devuelve {users, groups}.

Chat integrado en el cliente web.

Respuesta

{ users, groups }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/ChatUsers"

Opera sobre connected users. Sin DTO de respuesta declarado.

Chat integrado en el cliente web.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/ConnectedUsers"

Crea new chat. Lleva cuerpo JSON. Devuelve {id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, …}.

Chat integrado en el cliente web.

Cuerpo

application/json

Respuesta

{ id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, imageUrl, recipientId, username }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CreateNewChat`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Chat/CreateNewChat"

Descarga attachment. Devuelve un array de {id, recipientType}.

Chat integrado en el cliente web.

Parámetros

• attachmentNamequery
• attachmentFileNamequery

Respuesta

[ { id, recipientType } ]

Evidencia

Llamada en vivo → HTTP 405: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/DownloadAttachment"

Lee available chats. Devuelve un array de {id, isGroup, title, newMessagesCount, lastEditUTC, imageUrl}.

Chat integrado en el cliente web.

Respuesta

[ { id, isGroup, title, newMessagesCount, lastEditUTC, imageUrl } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetAvailableChats"

Lee chat. Devuelve {id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, …}.

Chat integrado en el cliente web.

Parámetros

• chatIdquery

Respuesta

{ id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, imageUrl, recipientId, username }

Evidencia

HTTP 404: el cliente web declara esta acción pero el servidor no la sirve. Código muerto del bundle.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetChat"

Lee connected users. Sin DTO de respuesta declarado.

Chat integrado en el cliente web.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetConnectedUsers"

Lee messages page. Exige chatId, lastMessageId, pageSize. Devuelve un array de {id, chatId, content, type, sender, senderViewName, …}.

Chat integrado en el cliente web.

Parámetros

• chatIdquery · obligatorio
• lastMessageIdquery · obligatorio
• pageSizequery · obligatorio

Respuesta

[ { id, chatId, content, type, sender, senderViewName, sent, sentUTC, isNew, presentationId, attachmentId, attachmentTag, imageUrl, capsulePath, screenId } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetMessagesPage?chatId=<chatId>&lastMessageId=<lastMessageId>&pageSize=<pageSize>"

Lee participants. Exige chatId. Devuelve un array de {username, viewName, imageUrl}.

Chat integrado en el cliente web.

Parámetros

• chatIdquery · obligatorio

Respuesta

[ { username, viewName, imageUrl } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetParticipants?chatId=<chatId>"

Lee screen attachment. Exige attachmentId. Devuelve {capsulePath, screen}.

Chat integrado en el cliente web.

Parámetros

• attachmentIdquery · obligatorio

Respuesta

{ capsulePath, screen }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetScreenAttachment?attachmentId=<attachmentId>"

Lee users. Devuelve un array de {image, id, name, viewName, displayName}.

Chat integrado en el cliente web.

Respuesta

[ { image, id, name, viewName, displayName } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/GetUsers"

Comprueba si password protected. Exige attachmentId. Devuelve {isProtected, capsulePath}.

Chat integrado en el cliente web.

Parámetros

• attachmentIdquery · obligatorio

Respuesta

{ isProtected, capsulePath }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/IsPasswordProtected?attachmentId=<attachmentId>"

Opera sobre mark read chat message. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Chat integrado en el cliente web.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action MarkReadChatMessage`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Chat/MarkReadChatMessage"

Opera sobre messages. Lleva cuerpo JSON. Devuelve un array de {id, chatId, content, type, sender, senderName, …}.

Chat integrado en el cliente web.

Cuerpo

application/json

Respuesta

[ { id, chatId, content, type, sender, senderName, senderViewName, sent, sentUTC, isNew, presentationId, attachmentId, attachmentTag, imageUrl, baseCapsuleUrl, capsulePath, screenId, attachmentFileLink, attachmentFileName } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Messages`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Chat/Messages"

Opera sobre participants. Devuelve un array de {userType, id, name, displayName, image, viewName}.

Chat integrado en el cliente web.

Parámetros

• chatIdquery

Respuesta

[ { userType, id, name, displayName, image, viewName } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Chat/Participants"

Envía message. Lleva cuerpo JSON. Devuelve {chatId, lastEditUTC, message}.

Chat integrado en el cliente web.

Cuerpo

application/json

Respuesta

{ chatId, lastEditUTC, message }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SendMessage`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Chat/SendMessage"

Actualiza chat. Lleva cuerpo JSON. Devuelve {id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, …}.

Chat integrado en el cliente web.

Cuerpo

application/json

Respuesta

{ id, isGroup, isCollaborationGroup, title, newMessagesCount, lastEditUTC, imageUrl, recipientId, username }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateChat`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Chat/UpdateChat"

Descarga attachment. Sin DTO de respuesta declarado.

Comentarios sobre celdas y objetos.

Parámetros

• attachmentNamequery
• attachmentFileNamequery

Evidencia

HTTP 404: el cliente web declara esta acción pero el servidor no la sirve. Código muerto del bundle.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Discussion/DownloadAttachment"

Guarda discussion. Lleva cuerpo JSON. Devuelve {firstKey, instanceId, title, isDesignMode, subject, lastOpenUTC, …}.

Comentarios sobre celdas y objetos.

Cuerpo

application/json

Respuesta

{ firstKey, instanceId, title, isDesignMode, subject, lastOpenUTC, screenId, capsulePath, answers }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveDiscussion`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Discussion/SaveDiscussion"

Borra blob. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteBlob`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Media/DeleteBlob"

Genera capsule image hash. Exige imageId, capsulePath. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Parámetros

• imageIdquery · obligatorio
• capsulePathquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Media/GenerateCapsuleImageHash?imageId=<imageId>&capsulePath=<capsulePath>"

Lee blob. Exige blobHash. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Parámetros

• blobHashquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Media/GetBlob?blobHash=<blobHash>"

Lee image. Exige imageHash. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Parámetros

• imageHashquery · obligatorio
• timestampquery
• thumbnailWidthquery
• thumbnailHeightquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Media/GetImage?imageHash=<imageHash>"

Lee thumb. Exige imageHash, size. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Parámetros

• imageHashquery · obligatorio
• sizequery · obligatorio
• timestampquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Media/GetThumb?imageHash=<imageHash>&size=<size>"

Actualiza dynawrite blob. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateDynawriteBlob`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Media/UpdateDynawriteBlob"

Sube blob. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Recursos multimedia de las capsules.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UploadBlob`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Media/UploadBlob"

Opera sobre {id}. Exige id. Sin DTO de respuesta declarado.

Novedades mostradas en el cliente.

Parámetros

• idpath · obligatorio
• versionquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/News/<id>/NewsImage"

Borra news. Sin DTO de respuesta declarado.

Novedades mostradas en el cliente.

Parámetros

• pkeyquery
• rkeyquery

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/News/DeleteNews"

Descarga image. Sin DTO de respuesta declarado.

Novedades mostradas en el cliente.

Parámetros

• attachmentNamequery

Evidencia

HTTP 404: el cliente web declara esta acción pero el servidor no la sirve. Código muerto del bundle.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/News/DownloadImage"

Opera sobre news by id. Lleva cuerpo JSON. Devuelve {firstKey, instanceId, title, imageFileName, imageVersion, icon, …}.

Novedades mostradas en el cliente.

Cuerpo

application/json

Respuesta

{ firstKey, instanceId, title, imageFileName, imageVersion, icon, subject, from, to, drafted, mustRead, userReadDate, orderField, recipients }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action NewsById`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/News/NewsById"

Guarda news. Lleva cuerpo JSON. Devuelve {firstKey, instanceId, title, imageFileName, imageVersion, icon, …}.

Novedades mostradas en el cliente.

Cuerpo

application/json

Respuesta

{ firstKey, instanceId, title, imageFileName, imageVersion, icon, subject, from, to, drafted, mustRead, userReadDate, orderField, recipients }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SaveNews`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/News/SaveNews"

Opera sobre user groups. Devuelve un array de {isNewsAuthor}.

Novedades mostradas en el cliente.

Respuesta

[ { isNewsAuthor } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/News/UserGroups"

Comprueba si se puede paste. Devuelve {toolbox, format, layout}.

Diseño de screens: colocar y configurar objetos.

Respuesta

{ toolbox, format, layout }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ScreenDesigner/CanPaste"

Crea el recurso del controlador. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Suscripciones a contenidos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Add`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Subscribe/Add"

Borra subscriptions. Lleva cuerpo JSON. Devuelve {startDateUTC, triggerType, recurDays, recurWeeks, timeZoneId, daysOfWeek, …}.

Suscripciones a contenidos.

Cuerpo

application/json

Respuesta

{ startDateUTC, triggerType, recurDays, recurWeeks, timeZoneId, daysOfWeek, monthsOfYear, daysOfMonth, weeksOfMonth }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteSubscriptions`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Subscribe/DeleteSubscriptions"

Lee el recurso del controlador. Devuelve un array de {capsulePath, screenId, presentationId, id, isInconsistentAction, name, …}.

Suscripciones a contenidos.

Respuesta

[ { capsulePath, screenId, presentationId, id, isInconsistentAction, name, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, presentationOrScreenName } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Subscribe/Get"

Ejecuta el recurso del controlador. Lleva cuerpo JSON. Devuelve {capsulePath, screenId, presentationId, id, isInconsistentAction, name, …}.

Suscripciones a contenidos.

Cuerpo

application/json

Respuesta

{ capsulePath, screenId, presentationId, id, isInconsistentAction, name, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, presentationOrScreenName }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Run`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Subscribe/Run"

Actualiza el recurso del controlador. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Suscripciones a contenidos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Update`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Subscribe/Update"

Actualiza status. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Suscripciones a contenidos.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateStatus`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Subscribe/UpdateStatus"

Lee toolbox parts. Exige cacheId. Devuelve un array de {id, part}.

Layouts: qué cubos y entidades cruza un objeto de datos.

Parámetros

• cacheIdquery · obligatorio

Respuesta

[ { id, part } ] — ToolboxPartDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Layout/GetToolboxParts?cacheId=<cacheId>"

Opera sobre multiple layout result. Lleva cuerpo JSON. Devuelve un array de {layoutId, layoutResult}.

Layouts: qué cubos y entidades cruza un objeto de datos.

Cuerpo

application/json

Respuesta

[ { layoutId, layoutResult } ] — ToolboxPartDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action MultipleLayoutResult`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Layout/MultipleLayoutResult"

Opera sobre single layout result. Lleva cuerpo JSON. Devuelve {type, databaseName, dynamicOptions, narration}.

Layouts: qué cubos y entidades cruza un objeto de datos.

Cuerpo

application/json

Respuesta

{ type, databaseName, dynamicOptions, narration } — LayoutResultDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SingleLayoutResult`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Layout/SingleLayoutResult"

Lee geo json files name. Devuelve un array de {name, canDelete}.

Objetos de mapa geográfico.

Respuesta

[ { name, canDelete } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Map/GetGeoJsonFilesName"

Lee dynamic ranges list. Devuelve un array de {name, items}.

Nexel: la rejilla tipo hoja de cálculo de Board.

Respuesta

[ { name, items } ]

Evidencia

Llamada en vivo → HTTP 500: la ruta existe, pero falta permiso o configuración (no es un 404).

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/NexelConfigurator/GetDynamicRangesList"

Lee rules. Exige databaseName. Devuelve un array de {ruleIdx, text}.

Apertura y estado del editor de layouts.

Parámetros

• databaseNamequery · obligatorio

Respuesta

[ { ruleIdx, text } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/OpenLayoutEditor/GetRules?databaseName=$BOARD_DB"

Lee rows format. Exige dbName. Devuelve un array de {isDefault, isDefaultForCharts, description, entityIdx}.

Formato condicional de filas.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { isDefault, isDefaultForCharts, description, entityIdx } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/RowFormatManager/GetRowsFormat?dbName=$BOARD_DB"

Lee svg files. Devuelve un array de {name, canDelete}.

Mapas SVG personalizados.

Respuesta

[ { name, canDelete } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SvgMap/GetSvgFiles"

Lee protocols table. Exige dbName. Devuelve {protocols, textFileDataSourceRepositories, availableSqlConnections, availableSapConnections}.

Drill through: saltar al dato de origen fuera del cubo.

Parámetros

• dbNamequery · obligatorio

Respuesta

{ protocols, textFileDataSourceRepositories, availableSqlConnections, availableSapConnections }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/DrillThrough/GetProtocolsTable?dbName=$BOARD_DB"

Opera sobre advanced search. Lleva cuerpo JSON. Devuelve {totalCount, totalCountPerItem, items}.

Búsqueda global en Board.

Cuerpo

application/json

Respuesta

{ totalCount, totalCountPerItem, items }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AdvancedSearch`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SearchEngine/AdvancedSearch"

Lee advanced search indexing values definition. Devuelve {minSearchKeyLength}.

Búsqueda global en Board.

Respuesta

{ minSearchKeyLength }

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SearchEngine/GetAdvancedSearchIndexingValuesDefinition"

Lee last indexing run. Sin DTO de respuesta declarado.

Búsqueda global en Board.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SearchEngine/GetLastIndexingRun"

Lee search engine settings. Devuelve {enabled, values, lastIndexingRun, searchableCapsules}.

Búsqueda global en Board.

Respuesta

{ enabled, values, lastIndexingRun, searchableCapsules }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SearchEngine/GetSearchEngineSettings"

Comprueba si enabled search engine. Sin DTO de respuesta declarado.

Búsqueda global en Board.

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SearchEngine/IsEnabledSearchEngine"

Fija capsule indexing configuration. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Búsqueda global en Board.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetCapsuleIndexingConfiguration`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SearchEngine/SetCapsuleIndexingConfiguration"

Fija indexing values definition. Lleva cuerpo JSON. Devuelve {delayAfterServiceStart, delayAfterLastModify, minSearchKeyLength}.

Búsqueda global en Board.

Cuerpo

application/json

Respuesta

{ delayAfterServiceStart, delayAfterLastModify, minSearchKeyLength }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action SetIndexingValuesDefinition`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SearchEngine/SetIndexingValuesDefinition"

Alterna search engine. Exige enableEngine. Sin DTO de respuesta declarado.

Búsqueda global en Board.

Parámetros

• enableEnginequery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/SearchEngine/ToggleSearchEngine?enableEngine=<enableEngine>"

Aplica dynamic selection web filters. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ApplyDynamicSelectionWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/ApplyDynamicSelectionWebFilters"

Comprueba paste data. Sin DTO de respuesta declarado.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Select/CheckPasteData"

Copia select web filters. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CopySelectWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/CopySelectWebFilters"

Opera sobre elements. Lleva cuerpo JSON. Devuelve {filtersDto, elements}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, elements } — ElementModelDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action Elements`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/Elements"

Ejecuta focus. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ExecuteFocus`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/ExecuteFocus"

Filtra elements web filters. Lleva cuerpo JSON. Devuelve {lastSearchRow, elementList}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ lastSearchRow, elementList }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FilterElementsWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/FilterElementsWebFilters"

Filtra to block references. Exige databaseName. Lleva cuerpo JSON. Devuelve un array de {entityIdx, entityName, elementIdx, elementDesc}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Parámetros

• databaseNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { entityIdx, entityName, elementIdx, elementDesc } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action FilterToBlockReferences`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/FilterToBlockReferences?databaseName=$BOARD_DB"

Lee entities. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetEntities`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/GetEntities"

Lee selection filters. Exige dbName, displayMode. Lleva cuerpo JSON. Devuelve un array de {entityIdx, totalElementCount, requestedElementList}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Parámetros

• dbNamequery · obligatorio
• displayModequery · obligatorio

Cuerpo

application/json

Respuesta

[ { entityIdx, totalElementCount, requestedElementList } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetSelectionFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/GetSelectionFilters?dbName=$BOARD_DB&displayMode=<displayMode>"

Opera sobre init dynamic selection. Lleva cuerpo JSON. Devuelve {isTemporal, isBasedOnCube, isCurrentDate, isPeriodsNotZero, isPeriod, isYearToDate, …}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ isTemporal, isBasedOnCube, isCurrentDate, isPeriodsNotZero, isPeriod, isYearToDate, isOffSet, offSetValue, isPreviousPeriod, isLatestPeriod, selectedBasedOnCube, cubes }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action InitDynamicSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/InitDynamicSelection"

Pega select web filters. Lleva cuerpo JSON. Devuelve un array de {webFilters, database, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

[ { webFilters, database, entities } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action PasteSelectWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/PasteSelectWebFilters"

Reinicia all. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ResetAll`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/ResetAll"

Reinicia selection. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ResetSelection`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/ResetSelection"

Actualiza selection from range web filters. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateSelectionFromRangeWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/UpdateSelectionFromRangeWebFilters"

Actualiza selection web filters. Lleva cuerpo JSON. Devuelve {filtersDto, entities}.

Selección: el filtro global que acota qué datos se ven. Concepto central de Board.

Cuerpo

application/json

Respuesta

{ filtersDto, entities }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateSelectionWebFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Select/UpdateSelectionWebFilters"

Lee security selection all filters. Lleva cuerpo JSON. Devuelve un array de {database, userSelections}.

Detalle de la selección activa.

Cuerpo

application/json

Respuesta

[ { database, userSelections } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetSecuritySelectionAllFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SelectionDetail/GetSecuritySelectionAllFilters"

Lee security selection filters. Exige dbName, maxElementsToProcess. Lleva cuerpo JSON. Devuelve un array de {entityIdx, totalElementCount, requestedElementList}.

Detalle de la selección activa.

Parámetros

• dbNamequery · obligatorio
• maxElementsToProcessquery · obligatorio

Cuerpo

application/json

Respuesta

[ { entityIdx, totalElementCount, requestedElementList } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action GetSecuritySelectionFilters`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/SelectionDetail/GetSecuritySelectionFilters?dbName=$BOARD_DB&maxElementsToProcess=<maxElementsToProcess>"

Crea una API Query: nombre (el que va en la URL pública), descripción y, opcionalmente, el layout que fija qué columnas devuelve. Es el puente: se prepara por la API interna y se consume por la pública.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { id, name, description, layout } ]

Evidencia

Cuerpo JSON, enums y trampas documentados en docs/actions/api-queries.md.

Receta completa: docs/actions/api-queries.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ApiQueriesManager/AddNewApiQuery?dbName=$BOARD_DB"

Vacía api query screen layout. Exige definitionId. Sin DTO de respuesta declarado.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• definitionIdquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ApiQueriesManager/ClearApiQueryScreenLayout?definitionId=<definitionId>"

Borra selected api queries. Exige dbName. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteSelectedApiQueries`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ApiQueriesManager/DeleteSelectedApiQueries?dbName=$BOARD_DB"

Edita api queries. Exige dbName. Lleva cuerpo JSON. Devuelve un array de {id, name, description, layout}.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• dbNamequery · obligatorio

Cuerpo

application/json

Respuesta

[ { id, name, description, layout } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action EditApiQueries`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/ApiQueriesManager/EditApiQueries?dbName=$BOARD_DB"

Lista las API Queries del modelo — es decir, qué endpoints `/public/{db}/query/{name}` existen. La API pública no puede listarse a sí misma; esta llamada es la única forma de descubrirlos.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• dbNamequery · obligatorio

Respuesta

[ { id, name, description, layout } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Receta completa: docs/actions/api-queries.md

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ApiQueriesManager/GetApiQueries?dbName=$BOARD_DB"

Reinicia decimal digits screen layout. Exige dbName, definitionId, areNotSavedItems. Devuelve {isConfiguredLayout, arePendingChanges, layoutTupleBased}.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

API Queries: las consultas del modelo que se publican como endpoints /public/{db}/query/{name}.

Parámetros

• dbNamequery · obligatorio
• definitionIdquery · obligatorio
• areNotSavedItemsquery · obligatorio

Respuesta

{ isConfiguredLayout, arePendingChanges, layoutTupleBased }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/ApiQueriesManager/ResetDecimalDigitsScreenLayout?dbName=$BOARD_DB&definitionId=<definitionId>&areNotSavedItems=<areNotSavedItems>"

Crea broadcast action dto. Lleva cuerpo JSON. Devuelve un array de {recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, …}.

Envío programado de capsules e informes a listas de destinatarios.

Cuerpo

application/json

Respuesta

[ { recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, name, note, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, signature, boardRecipients, externalRecipients } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddBroadcastActionDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Broadcast/AddBroadcastActionDto"

Cambia status dto. Lleva cuerpo JSON. Devuelve {recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, …}.

Envío programado de capsules e informes a listas de destinatarios.

Cuerpo

application/json

Respuesta

{ recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, name, note, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, signature, boardRecipients, externalRecipients }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ChangeStatusDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Broadcast/ChangeStatusDto"

Vacía broadcasting screen state. Exige actionId. Sin DTO de respuesta declarado.

⚠️ Es un GET y borra. Basta con pedir la URL — no la incluyas en ningún barrido automático.

Envío programado de capsules e informes a listas de destinatarios.

Parámetros

• actionIdquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Broadcast/ClearBroadcastingScreenState?actionId=<actionId>"

Borra broadcast actions. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Envío programado de capsules e informes a listas de destinatarios.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DeleteBroadcastActions`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Broadcast/DeleteBroadcastActions"

Lee address book. Devuelve un array de {id, name, email, displayName, avatarUrl}.

Envío programado de capsules e informes a listas de destinatarios.

Respuesta

[ { id, name, email, displayName, avatarUrl } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Broadcast/GetAddressBook"

Lee broadcast list dto. Devuelve un array de {recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, …}.

Envío programado de capsules e informes a listas de destinatarios.

Respuesta

[ { recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, name, note, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, signature, boardRecipients, externalRecipients } ]

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Broadcast/GetBroadcastListDto"

Lee export presentation action roots. Sin DTO de respuesta declarado.

Envío programado de capsules e informes a listas de destinatarios.

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Broadcast/GetExportPresentationActionRoots"

Lee layout recipients blocks. Exige actionId, areNotSavedItems. Devuelve un array de {value, letter, translation, isTextValue}.

Envío programado de capsules e informes a listas de destinatarios.

Parámetros

• actionIdquery · obligatorio
• areNotSavedItemsquery · obligatorio

Respuesta

[ { value, letter, translation, isTextValue } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Broadcast/GetLayoutRecipientsBlocks?actionId=<actionId>&areNotSavedItems=<areNotSavedItems>"

Ejecuta broadcast action dto. Lleva cuerpo JSON. Devuelve un array de {recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, …}.

Envío programado de capsules e informes a listas de destinatarios.

Cuerpo

application/json

Respuesta

[ { recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, name, note, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, signature, boardRecipients, externalRecipients } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action RunBroadcastActionDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Broadcast/RunBroadcastActionDto"

Actualiza broadcast actions dto. Lleva cuerpo JSON. Devuelve un array de {recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, …}.

Envío programado de capsules e informes a listas de destinatarios.

Cuerpo

application/json

Respuesta

[ { recipientsType, layoutRecipients, enableImpersonification, presentationId, id, isInconsistentAction, name, note, createdUTC, lastRunUTC, owner, format, subject, messageBody, subscriptionType, isEnabled, period, nextRunUTC, signature, boardRecipients, externalRecipients } ]

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action UpdateBroadcastActionsDto`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Broadcast/UpdateBroadcastActionsDto"

Crea screen to presentation. Lleva cuerpo JSON. Devuelve {id, title, description, creationUTC, lastEditUTC, owner, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ id, title, description, creationUTC, lastEditUTC, owner, ownerMail, ownerId, userInfo }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action AddScreenToPresentation`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/AddScreenToPresentation"

Opera sobre archive presentation. Lleva cuerpo JSON. Sin DTO de respuesta declarado.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ArchivePresentation`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/ArchivePresentation"

Vacía custom changes from screen slide. Lleva cuerpo JSON. Devuelve {presentationId, scenarioId, customFiltersCleared, objectConfigurationsCleared}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ presentationId, scenarioId, customFiltersCleared, objectConfigurationsCleared }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action ClearCustomChangesFromScreenSlide`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X PATCH -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/ClearCustomChangesFromScreenSlide"

Crea presentation. Lleva cuerpo JSON. Devuelve {id, title, description, creationUTC, lastEditUTC, owner, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ id, title, description, creationUTC, lastEditUTC, owner, ownerMail, ownerId, userInfo }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CreatePresentation`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/CreatePresentation"

Crea slide header. Lleva cuerpo JSON. Devuelve {id, name, notesType, notes, autoShowNotes, creationUTC, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ id, name, notesType, notes, autoShowNotes, creationUTC, lastEditUTC, bannerColor } — SlideDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CreateSlideHeader`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/CreateSlideHeader"

Crea slide screen. Lleva cuerpo JSON. Devuelve {id, name, notesType, notes, autoShowNotes, creationUTC, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ id, name, notesType, notes, autoShowNotes, creationUTC, lastEditUTC, bannerColor } — SlideDto

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action CreateSlideScreen`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/CreateSlideScreen"

Borra presentation. Exige id. Sin DTO de respuesta declarado.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• idpath · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/DeletePresentation/<id>"

Borra slide. Exige presentationId, slideId. Sin DTO de respuesta declarado.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• presentationIdquery · obligatorio
• slideIdquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/DeleteSlide?presentationId=<presentationId>&slideId=<slideId>"

Duplica presentation. Lleva cuerpo JSON. Devuelve {id, title, description, creationUTC, lastEditUTC, owner, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Cuerpo

application/json

Respuesta

{ id, title, description, creationUTC, lastEditUTC, owner, ownerMail, ownerId, userInfo }

Evidencia

Escritura con cuerpo JSON. NSwag no deja el tipo del argumento en el bundle, pero la forma se recupera con `node tools/board-shape.js .chunks --action DuplicatePresentation`.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -X POST -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '<cuerpo>' \
  "$BOARD_HOST/api/Presentation/DuplicatePresentation"

Lee presentation details. Exige id. Devuelve {id, title, description, transitionTimer, restart, slides}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• idpath · obligatorio

Respuesta

{ id, title, description, transitionTimer, restart, slides } — SlideDto

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetPresentationDetails/<id>"

Lee presentation info. Exige id. Devuelve {id, title, description, creationUTC, lastEditUTC, owner, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• idpath · obligatorio

Respuesta

{ id, title, description, creationUTC, lastEditUTC, owner, ownerMail, ownerId, userInfo }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetPresentationInfo/<id>"

Lee presentation sharable users. Exige presentationId. Devuelve {publicCanView, publicCanEdit, availableUsers, sharedUsersMetadata}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• presentationIdquery · obligatorio

Respuesta

{ publicCanView, publicCanEdit, availableUsers, sharedUsersMetadata }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetPresentationSharableUsers?presentationId=<presentationId>"

Lee presentation sharable users groups. Exige presentationId. Devuelve {availableUsers, availableGroups, sharedUsersMetadata, sharedGroupsMetadata}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• presentationIdquery · obligatorio

Respuesta

{ availableUsers, availableGroups, sharedUsersMetadata, sharedGroupsMetadata }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetPresentationSharableUsersGroups?presentationId=<presentationId>"

Lee presentations info. Exige includeUserInfo. Devuelve un array de {id, title, description, creationUTC, lastEditUTC, owner, …}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• includeUserInfoquery · obligatorio

Respuesta

[ { id, title, description, creationUTC, lastEditUTC, owner, ownerMail, ownerId, userInfo } ]

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetPresentationsInfo?includeUserInfo=<includeUserInfo>"

Lee slide screen. Exige presentationId, slideId. Devuelve {id, screen, hasCustomFilters, hasCustomObjects}.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• presentationIdquery · obligatorio
• slideIdquery · obligatorio

Respuesta

{ id, screen, hasCustomFilters, hasCustomObjects }

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetSlideScreen?presentationId=<presentationId>&slideId=<slideId>"

Lee user list. Devuelve un array de {id, name, email, displayName, avatarUrl}.

Presentaciones: secuencias de slides construidas sobre screens.

Respuesta

[ { id, name, email, displayName, avatarUrl } ] — PresentationCreateDto

Evidencia

Llamada en vivo → HTTP 200. Responde por HTTP sin navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/GetUserList"

Refresca slide filters. Exige presentationId, slideId. Sin DTO de respuesta declarado.

Presentaciones: secuencias de slides construidas sobre screens.

Parámetros

• presentationIdquery · obligatorio
• slideIdquery · obligatorio

Evidencia

Sin probar: sus parámetros obligatorios no se pueden rellenar sin inventar ids. No hay indicio de que necesite navegador.

Invocación

TOKEN=$(./tools/board-token.sh)
curl -H "Authorization: Bearer $TOKEN" \
  "$BOARD_HOST/api/Presentation/RefreshSlideFilters?presentationId=<presentationId>&slideId=<slideId>"

Refresca slide layouts. Exige presentationId, slideId. Sin DTO de respuesta declarado.