Skip to content

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:

ArgumentoUbicaciónDescripción
projectQueryFiltro opcional por project fullname.
workspaceQueryFiltro 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:

CampoObligatorioDescripción
nameSíApp name.
fullnameSíApp fullname.
projectSíProject fullname.
workspaceSíWorkspace fullname.
urlSíApp URL.
tagsNoTags.
labelsNoLabels.

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:

ArgumentoUbicaciónDescripción
projectQueryFiltro opcional por project.
workspaceQueryFiltro 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:

CampoObligatorioDescripción
nameSíAction name.
fullnameSíAction fullname.
projectSíProject fullname.
workspaceSíWorkspace fullname.
backendSíAction backend definition.
valuesSíAction values schema.
overridesSíCampos que la action puede sobrescribir.
tagsNoTags.
labelsNoLabels.
metaSí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:

ArgumentoUbicaciónDescripción
appQueryFiltro opcional por app fullname.
projectQueryFiltro opcional por project fullname.
workspaceQueryFiltro 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:

CampoObligatorioDescripción
nameSíBlueprint name.
fullnameSíBlueprint fullname.
appSíApp fullname.
projectSíProject fullname.
workspaceSíWorkspace fullname.
typeSíplain o external.
dataNoObject spec.
tagsNoTags.
labelsNoLabels.
meta.titleNoTítulo visible.
meta.descriptionNoDescripció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:

ArgumentoUbicaciónDescripción
projectQueryFiltro opcional por project.
workspaceQueryFiltro opcional por workspace.
statusQuerynot_tested, ready o broken.
palletQueryFiltro opcional por pallet.
kindQueryevent, call, transaction o timer.
dataSourceQueryFiltro 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:

ArgumentoUbicaciónDescripción
triggerQueryFullname del trigger.
refQueryReferencia del type schema que se resolverá.
qQueryBúsqueda de texto opcional.
valueQueryValor exacto opcional.
limitQueryLímite de resultados opcional.
Campos adicionalesQueryValores 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:

CampoObligatorioDescripción
nameSíShared type collection name.
fullnameSíShared type fullname.
projectSíProject fullname.
workspaceSíWorkspace fullname.
schemasSíObjeto con named type schemas.
tagsNoTags.
labelsNoLabels.
metaNoMetadata object.

Respuesta: SharedTypeView.

DELETE /api/types/:fullname ​

Elimina un shared type.

Argumentos: fullname como path argument.

Payload: ninguno.

Respuesta: OperationResult.