插入任务-InsertTask
1. 单任务添加接口
单个插入3D模型,3D装配体模型,2D图纸等模型转换。每个任务会生成一份轻量化数据。注意插入装配体模型时,需要将装配体模型压缩为zip文件,并指定mainFile参数为主装文件名。
请求方式: POST
URL地址: [YunapiUrl]/nds_requests/common/InsertTask
接口说明 |
---|
添加一条转换任务。必须在模型文件成功上传到轻量化服务平台后,才可调用任务添加接口。上传的文件以“时间戳 + 随机数”命名,不含中文。 |
字段名 | 变量名 | 必填 | 类型 | 说明 |
---|---|---|---|---|
Nds文件名 | inputNdsFile | 否 | String | 上传到Nds公有云存储目录的文件名称。请填写通过临时授权接口上传文件后返回的inputNdsFile |
文件路径 | inputURL | 否 | String | 可直接提供文件下载地址。注意inputURL 、inputNdsFile 必须有一个不为空 |
主文件 | mainFile | 否 | String | 如果上传的是zip文件,不能为空,请填写需要转换的文件名称,装配体文件填写主装文件名称,其他情况可为空 |
任务描述 | taskDescription | 否 | String | taskDescription为非必填,且内部参数可选填。详见枚举值-taskDescription 任务描述说明 |
回调地址 | returnURL | 否 | String | 任务处理完成后的回调 |
任务优先级 | priority | 否 | Int | 默认为0,值越大,优先级越高 |
字段名 | 变量名 | 必填 | 类型 | 说明 |
---|---|---|---|---|
接口状态 | status | 是 | json | 接口的调用状态,包含接口返回码和错误信息 |
接口数据 | data | 是 | json | 接口的返回数据,包含任务ID |
字段名 | 属性名 | 必填 | 类型 | 说明 |
---|---|---|---|---|
返回码 | code | 是 | String | 见枚举值-code 返回码说明 |
错误信息 | msg | 是 | String | 错误信息 |
字段名 | 属性名 | 必填 | 类型 | 说明 |
---|---|---|---|---|
任务ID | taskID | 是 | String | 任务ID |
2. 示例
请求示例:
curl --location 'https://api.3dopen.cn/nds_requests/Common/InsertTask' \
--header 'timeStampData: 1727087763' \
--header 'partnerID: xxx' \
--header 'shaKeyData: xxx' \
--form 'inputNdsFile="202409231651498966/3D.step"'
返回示例:
{
"status": {
"code": 1,
"msg": "成功"
},
"data": {
"taskID": 3674705
}
}