Apps, Actions, Blueprints y Types API
Estos endpoints describen el builder/registry layer: apps, actions, blueprints y shared types. Se usan para service integrations y definiciones reutilizables de resource/action.
Apps
GET /api/apps
Devuelve apps.
Argumentos:
| Argumento | Ubicación | Descripción |
|---|---|---|
project | Query | Filtro opcional por project fullname. |
workspace | Query | Filtro opcional por workspace fullname. |
Payload: ninguno.
Respuesta: AppView[].
GET /api/apps/:fullname
Devuelve una app.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: AppView.
PUT /api/apps/:fullname
Crea o actualiza una app.
Payload:
| Campo | Obligatorio | Descripción |
|---|---|---|
name | Sí | App name. |
fullname | Sí | App fullname. |
project | Sí | Project fullname. |
workspace | Sí | Workspace fullname. |
url | Sí | App URL. |
tags | No | Tags. |
labels | No | Labels. |
Respuesta: AppView.
DELETE /api/apps/:fullname
Elimina una app.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: OperationResult.
Actions
GET /api/actions
Devuelve actions.
Argumentos:
| Argumento | Ubicación | Descripción |
|---|---|---|
project | Query | Filtro opcional por project. |
workspace | Query | Filtro opcional por workspace. |
Payload: ninguno.
Respuesta: ActionView[].
GET /api/actions/:fullname
Devuelve una action.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: ActionView.
PUT /api/actions/:fullname
Crea o actualiza una action.
Payload:
| Campo | Obligatorio | Descripción |
|---|---|---|
name | Sí | Action name. |
fullname | Sí | Action fullname. |
project | Sí | Project fullname. |
workspace | Sí | Workspace fullname. |
backend | Sí | Action backend definition. |
values | Sí | Action values schema. |
overrides | Sí | Campos que la action puede sobrescribir. |
tags | No | Tags. |
labels | No | Labels. |
meta | Sí | Action metadata. |
Respuesta: ActionView.
DELETE /api/actions/:fullname
Elimina una action.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: OperationResult.
Blueprints
GET /api/blueprints
Devuelve blueprints.
Argumentos:
| Argumento | Ubicación | Descripción |
|---|---|---|
app | Query | Filtro opcional por app fullname. |
project | Query | Filtro opcional por project fullname. |
workspace | Query | Filtro opcional por workspace fullname. |
Payload: ninguno.
Respuesta: BlueprintView[].
GET /api/blueprints/:fullname
Devuelve un blueprint.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: BlueprintView.
PUT /api/blueprints/:fullname
Crea o actualiza un blueprint.
Payload:
| Campo | Obligatorio | Descripción |
|---|---|---|
name | Sí | Blueprint name. |
fullname | Sí | Blueprint fullname. |
app | Sí | App fullname. |
project | Sí | Project fullname. |
workspace | Sí | Workspace fullname. |
type | Sí | plain o external. |
data | No | Object spec. |
tags | No | Tags. |
labels | No | Labels. |
meta.title | No | Título visible. |
meta.description | No | Descripción. |
Respuesta: BlueprintView.
DELETE /api/blueprints/:fullname
Elimina un blueprint.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: OperationResult.
Types
GET /api/types
Devuelve shared types.
Argumentos:
| Argumento | Ubicación | Descripción |
|---|---|---|
project | Query | Filtro opcional por project. |
workspace | Query | Filtro opcional por workspace. |
status | Query | not_tested, ready o broken. |
pallet | Query | Filtro opcional por pallet. |
kind | Query | event, call, transaction o timer. |
dataSource | Query | Filtro opcional por data source. |
Payload: ninguno.
Respuesta: SharedTypeView[].
GET /api/types/lookup
Resuelve opciones dinámicas de tipos para el catálogo de un trigger.
Argumentos:
| Argumento | Ubicación | Descripción |
|---|---|---|
trigger | Query | Fullname del trigger. |
ref | Query | Referencia del type schema que se resolverá. |
q | Query | Búsqueda de texto opcional. |
value | Query | Valor exacto opcional. |
limit | Query | Límite de resultados opcional. |
| Campos adicionales | Query | Valores de dependencias opcionales como series o event. |
Payload: ninguno.
La respuesta contiene ref, items normalizados con label, value y parents opcional, además de un nextCursor opcional.
GET /api/types/:fullname
Devuelve un shared type.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: SharedTypeView.
PUT /api/types/:fullname
Crea o actualiza un shared type.
Payload:
| Campo | Obligatorio | Descripción |
|---|---|---|
name | Sí | Shared type collection name. |
fullname | Sí | Shared type fullname. |
project | Sí | Project fullname. |
workspace | Sí | Workspace fullname. |
schemas | Sí | Objeto con named type schemas. |
tags | No | Tags. |
labels | No | Labels. |
meta | No | Metadata object. |
Respuesta: SharedTypeView.
DELETE /api/types/:fullname
Elimina un shared type.
Argumentos: fullname como path argument.
Payload: ninguno.
Respuesta: OperationResult.