插入任务-InsertHtmlConvertTask

1. 插入离线预览html转换任务接口

使用转换后的轻量化数据及业务端添加批注、视图等信息数据,通过该接口可生成可离线预览的单个html文件,html文件支持PC端和移动端离线打开预览模型。

请求方式: POST

URL地址:  [YunapiUrl]/nds_requests/common/InsertHtmlConvertTask

Table 1. 接口说明
接口说明
添加一条轻量化数据生成离线预览html的转换任务。输入文件必须是zip文件,建议上传的文件以“时间戳 + 随机数”命名,不含中文,zip文件根目录内容包括:
  • 轻量化数据文件
  • 其他数据信息viewerConfig.json
    注意文件使用utf-8格式保存。
    viewerConfig.json文件结构如下:
    {
    "viewerPorts":[], //视图 数据,js调用nd_viewCtrl. nd_getViewportList 方法可以获取当前视图信息。
    "modelTags":[], // 批注数据,js调用nd_viewCtrl.nd_getAllTags方法可以获取当前批注。
    "hideParts":[] //隐藏模型, js调用nd_viewCtrl.nd_getHideObjectidLists方法可以获取隐藏部件objectId集合信息。
    }
  • 动画信息

    如果导出html需要添加额外的动画信息,需要使用动画工具生成对应的动画信息,拷贝到转换的轻量化数据中(单配置模型拷贝到轻量化默认文件夹"/0"中,多配置模型需要拷贝到对应配置的轻量化文件夹中)

Table 2. 请求参数
字段名 变量名 必填 类型 说明
文件名 inputFiles String 输入文件压缩包(轻量化数据及批注文件压缩包)
文件路径类型 inputType Int 0:minio
1:http 路径
2:ftp 路径
3dspace文件路径 outLightURL String 使用3Dspace存储方式,返回的在线3Dspace轻量化文件夹地址。当outLightURL不为空时,inputFiles可以为空。
轻量化预览类型 viewerType Int 1:3D 轻量化
2:2D 轻量化
3:自定义
默认为1
模型名称 modelName String 模型名称,预览模型标题(空时标题显示生成“html”的文件名称)
自定义预览模板 viewerPath String viewerType为3时:inputFiles压缩包中viewer模板相对路径
主装文件夹路径 assemblyFolder String 主装文件夹路径(子件转换轻量化数据必传,其他转换不传)
回调地址 returnURL String 任务处理完成后的 回调
任务优先级 priority Int 默认为0,值越大,优先级越高
输出html类型 htmlType Int 默认为0
0:PC
1: 移动端
2:PC和移动端混合支持
Table 3. 返回参数
字段名 变量名 必填 类型 说明
接口状态 status json 接口的调用状态,包含接口返回码和错误信息
接口数据 data json 接口的返回数据,包含任务ID
Table 4. 变量status的属性值
字段名 变量名 必填 类型 说明
返回码 code String 枚举值-code 返回码说明
错误信息 msg String 错误信息
Table 5. 变量data的属性值
字段名 变量名 必填 类型 说明
任务ID taskID String 任务ID

2. 示例

请求示例:

curl --location 'https://api.3dopen.cn/nds_requests/Common/InsertHtmlConvertTask' \
--header 'timeStampData: 1727087763' \
--header 'partnerID: xxx' \
--header 'shaKeyData: xxx' \
--form 'inputNdsFile="202409231651498966/model.zip"'

返回示例:

{
    "status": {
        "code": 1,
        "msg": "成功"
    },
    "data": {
        "taskID": 1
    }
}