插入任务-InsertPartConvertAddTask

1. 插入子件转换任务接口

可对单个零件或装配体文件转换为与模型一一对应的轻量化数据信息,单个零件轻量化可以单独显示,装配体轻量化显示时会加载相关的零件一同显示。

请求方式: POST

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

Table 1. 接口说明
接口说明
添加一条子件转换任务。子件转换任务,转换文件必须是zip压缩包文件,必须在模型文件成功上传到轻量化服务平台后,才可调用任务添加接口。建议上传的文件以“时间戳 + 随机数”命名,不含中文。

输入文件zip文件根目录内容包括:

  • Models文件夹
    该文件夹中存放待转换的原始模型文件。
  • Lights文件夹
    该模型中存放转换后的轻量化模型文件,当首次转换或其他场景中没有用到轻量化后文件时,可以为空。
  • 转换配置文件:Convert.json
    定义主装文件,与需要转换的模型名称、uuid 、路径信息。
Table 2. 请求参数
字段名 变量名 必填 类型 说明
Nds文件名 inputNdsFile String 上传到Nds公有云存储目录的文件名称,请填写上传临时授权时返回的inputNdsFile
文件路径 inputURL String 可直接提供文件下载地址。注意inputURL、inputNdsFile 必须有一个不为空
回调地址 returnURL String 任务处理完成后的回调处理 returnURL
任务优先级 priority Int 默认为0,值越大,优先级越高
任务描述 taskDescription String
{
"Detail":"-1", 
"Detect":"1", 
"Brep":"1", 
"Mesh":"1", 
"Pmi":"1", 
"Prop":"1", 
"Camera":"1", 
"Animate":"1", 
"Sketch":"1" 
}
taskDescription为非必填,且内部参数可选填。 详见枚举值-taskDescription 任务描述说明
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/InsertPartConvertAddTask' \
--header 'timeStampData: 1727087763' \
--header 'partnerID: xxx' \
--header 'shaKeyData: xxx' \
--form 'inputNdsFile="202409231651498966/model.zip"'

返回示例:

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