SuperAPI AI 工具集

launchpad-dx-apis

编程与开发

查看项目

更新于 10-16 03:17

技能介绍

Launchpad 数据模型由 Application 及其 Workflow、Data 组成,Constellation UI 用于创建和运行这些工作流与数据。当需要从外部系统通过 REST 服务创建案例,或由外部系统完成工作流某一步骤时,可使用 DX API(Digital Experience API)。它以 REST 端点形式提供数据和视图元信息,便于在外部系统展示对象。

主要能力

Create Case 或 Data 对象 获取 Case/Data 信息 对特定工作流/案例执行 action 按过滤条件获取对象列表 获取附件等应用附加内容

认证

Launchpad 支持 OAuth 2.0 调用 DX API。需在 Subscriber 环境创建 Client Registration 规则,并指定 Persona;调用时访问权限与 Privilege 由该 Persona 决定。外部系统需先向 Launchpad 宿主团队获取 4 项信息:Application URL、AccessTokenURL、ClientID、Client Secret。AccessToken URL 用于认证,Application URL 用于调用 DX API。

创建案例(标量内容)

POST https:///dx/api/application/v2/cases 请求体包含 caseTypeID 与 content,例如 ExpenseRequest、ExpenseeRaisedBy、Name、Category、Expenses 数组、TotalAmount、Team、ReasonforExpense。响应返回 caseInfo,含 caseTypeID、caseTypeName、createTime、createdBy、ID、businessID、assignments 与 availableActions,其中 actions 链接可用于后续 PATCH 操作。无权限时报 403。

创建 Data 对象

POST https:///dx/api/application/v2/objects 请求体使用 objectTypeID 而非 caseTypeID,例如 Category 与 CategoryName。响应返回新对象 ID。

字段与限制

请求体中的字段必须配置为 Allowed Fields,否则会报无效数据错误;Allowed Fields 中的必填字段为必需;传入未配置字段将被忽略。建议保存返回的案例 ID 以供后续引用。

获取案例或数据对象

GET https:///dx/api/application/v2/cases/{ID} 用于获取已创建对象的完整详情,响应含 Assignment Actions(如 Approve、Reject 等必需操作及 outcome)与 Available Actions(如 ProvideAdditionalDetails、Edit、pyChangeStage、RestartCurrentStage 等可选操作,可多次执行)。无权限时报 404。响应头 eTag 用于后续更新时的 If-Match。

更新案例或数据对象

PATCH(使用 Get/Create 响应中的 actions href),需带 If-Match: eTag 值。可执行仅单结果的 Available Action、选择 outcome 的 Assignment Action 或 Available Action。无权限报 404;案例/阶段/步骤校验不通过则报 400 并附错误详情。

Data DX API 列表查询

POST https:///dx/api/application/v2/data_views/{DataPageName} 请求体含 dataViewParameters 与 query.select 字段列表,响应返回 data 数组及 pageNumber、pageSize、fetchDateTime、totalCount。适用于不知道 Launchpad 生成 ID、但知道某字段值且已有暴露该参数的 Data page 的场景。

可根据用户具体用例建议对应模式,询问 case type、Allowed Fields 及字段值以生成请求与响应示例,也可生成包含全部案例及其 action、字段详情的 YAML 文件。