操作

/api/action/端点。

DELETE /api/action/:action-id

删除一个动作。

参数

• action-id的值必须是一个大于零的整数。

DELETE /api/action/:id/public_link

删除此仪表板的公开访问链接。

参数

• id的值必须是一个大于零的整数。

GET /api/action/

返回可用于QueryActions的动作。默认情况下列出所有可查看的动作。通过传递可选的?model-id=<model-id>来限制特定模型上的动作。

参数

• model-id的可空值必须是一个大于零的整数。

GET /api/action/:action-id

获取一个动作。

参数

• action-id的值必须是一个大于零的整数。

GET /api/action/:action-id/execute

获取用于填充执行参数的值。传递PK参数和值以选择。

参数

• action-id的值必须是一个大于零的整数。

• parameters的值必须是一个有效的JSON字符串。

GET /api/action/public

获取具有公开UUIDs的动作列表。如果启用公开共享，则这些动作是公开可访问的。

POST /api/action/

创建一个新的动作。

参数

• visualization_settings的可空映射。

• parameters的可空映射序列。

• description的可空字符串。

• error_handle的可空字符串，并且必须是一个有效的json-query，例如‘.item.title’。

• database_id 可空值必须是一个大于零的整数。

• name 字符串。

• response_handle 可空字符串，必须是一个有效的 json-query，例如 'item.title'。

• template 可空映射，其中 {:method -> <GET, POST, PUT, DELETE, PATCH> 枚举类型, :url ->= 1>, :body (可选) ->, :headers (可选) ->, :parameters (可选) ->, :parameter_mappings (可选) ->} 不包含其他键。

• type 可空 不支持的操作类型。

• dataset_query 可空映射。

• model_id 值必须是一个大于零的整数。

• kind 可空 不支持的内隐操作类型。

• parameter_mappings 可空映射。

• 操作

POST /api/action/:id/execute

执行操作。

parameters 应该是具有值的映射仪表板参数。

参数

• id的值必须是一个大于零的整数。

• parameters 可空映射从到.

• _body

POST /api/action/:id/public_link

为这个操作生成公开可访问的链接。返回用于公开链接的 UUID（如果这个操作已经共享，将返回现有的公开链接而不是创建新的链接）。必须启用公开分享。

您必须是一个超级用户才能执行此操作。

参数

• id的值必须是一个大于零的整数。

PUT /api/action/:id

更新操作。

参数

• id的值必须是一个大于零的整数。

• action 映射，其中 {:archived (可选) ->, :database_id (可选) ->, :dataset_query (可选) ->, :description (可选) ->, :error_handle (可选) -> <可空字符串，必须是一个有效的 json-query，例如 '.item.title'>, :kind (可选) ->, :model_id (可选) ->, :name (可选) ->, :parameter_mappings (可选) ->, :parameters (可选) ->, :response_handle (可选) -> <可空字符串，必须是一个有效的 json-query，例如 '.item.title'>, :template (可选) -> <可空映射，其中 {:method -> <GET, POST, PUT, DELETE, PATCH> 枚举类型, :url ->= 1>, :body (可选) ->, :headers (可选) ->, :parameters (可选) ->, :parameter_mappings (可选) ->} 不包含其他键>, :type (可选) ->, :visualization_settings (可选) ->}.

---

「 返回 API 索引