API 接口

1. 数据传输接口

1.1 临时授权接口

URL地址： http://[domain]/nds_requests/common/GetPresignedUploadUrl


接口说明
获取位于公有云文件服务器上的临时授权上传路径，可通过该路径将模型上传。上传授权有效时间60分钟

Table 1. 请求参数
字段名	变量名	必填	类型	说明
文件名称	fileName	是	String	需上传的文件名称，如“box.prt”

Table 2. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含临时上传路径相关信息

Table 3. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 4. 变量data的属性值
字段名	属性名	必填	类型	说明
临时授权路径	url	是	String	返回临时授权路径
授权上传对象	inputNdsFile	是	String	返回授权上传对象

获取临时上传授权路径后，将选择的文件上传到对应授权路径下，然后再插入任务。
临时授权路径使用PUT方式将文件上传到云文件服务中，前端上传示例如下：

     let file = $('#fileSelect')[0].files[0];
     $.ajax({
                    url: url,
                    type: "put",
                    data: file, 
                    async: true,
                    processData: false,
                    contentType: false,
                    error: function (xhr, status, error) {                   
                       
                    },
                    success: function (result) {
                        
                    },
                });

1.2 FTP接口

轻量化服务平台FTP信息，返回值为FTP地址、用户名和密码。

Note:

获得的FTP用户名和密码使用base64加密，并从第二位开始插入加密密钥，解析时请从第二位开始删除密钥（门户网站 ftp密钥信息），然后进行base64解密。

POST http://[domain]/nds_requests/common/GetFTPInfo

请求参数：无

Table 5. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含FTP相关信息

Table 6. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 7. 变量data的属性值
字段名	属性名	必填	类型	说明
ftp地址	ftp	是	String	ftp地址
ftp用户名	ftpUserName	是	String	ftp用户名
ftp密码	ftpPassword	是	String	ftp密码

返回数据示例：

{
    "status": {
        "code": 1,
        "msg": "成功"
    },
    "data": {
        "ftp": "ftp://118.31.117.19:21",
        "ftpUserName": "e[ftp密钥]XVxxxx",
        "ftpPassword": "e[ftp密钥]XVxxxx"
    }
}

2.任务添加接口

2.1 模型转换

2.1.1 单任务添加接口

URL地址： http://[domain]/nds_requests/common/InsertTask


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

Table 8. 请求参数
字段名	变量名	必填	类型	说明
文件名	inputFiles	否	String	上传到FTP目录的文件名称。请填写相对路径，例如“38237874832438.zip”。支持压缩包（必须为zip格式，且不含二级目录，文件统一放在根目录下）和非压缩包。如果是装配体，请以压缩包形式上传
Nds文件名	inputNdsFile	否	String	上传到Nds公有云存储目录的文件名称。请填写通过临时授权接口上传文件后返回的inputNdsFile
文件路径	inputURL	否	String	可直接提供文件下载地址。注意 inputFiles 、inputURL 、inputNdsFile 必须有一个不为空
主文件	mainFile	否	String	如果上传的是zip文件，请填写需要转换的文件名称，装配体文件填写主装文件名称，其他情况可为空
任务描述	taskDescription	否	String	`{ "Detail":"-1", "Detect":"1", "Brep":"1", "Mesh":"1", "Pmi":"1", "Prop":"1", "Camera":"1", "Animate":"1", "Sketch":"1" }` taskDescription为非必填，且内部参数可选填。详见5.2 任务描述说明
回调地址	returnURL	否	String	任务处理完成后的回调
任务优先级	priority	否	Int	默认为0，值越大，优先级越高

Table 9. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务ID

Table 10. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 11. 变量data的属性值
字段名	属性名	必填	类型	说明
任务ID	taskID	是	String	任务ID

2.1.2 批量任务添加接口

URL地址：http://[domain]/nds_requests/common/BatchInsertTask


接口说明
添加多条转换任务。必须在模型文件成功上传到轻量化服务平台后，才可调用任务添加接口。上传的文件以“时间戳 + 随机数”命名，不含中文。

Table 12. 请求参数
字段名	变量名	必填	类型	说明
文件名	inputFiles	是	String	上传到ftp目录的文件名称。请填写相对路径，如“38237874832438.zip”,仅支持压缩包（必须为zip格式）
Nds文件名	inputNdsFile	否	String	上传到Nds公有云存储目录的文件名称，请填写上传临时授权时返回的inputNdsFile
文件路径	inputURL	否	String	可直接提供文件下载地址。其中 inputFiles 、inputURL 、inputNdsFile必须有一个不为空
回调地址	returnURL	否	String	回调地址。如果不为空，则采取回调的方式发送处理结果，详见2.4 回调
任务优先级	priority	否	Int	默认为0，值越大，优先级越高

Table 13. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务ID

Table 14. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 15. 变量data的属性值
字段名	属性名	必填	类型	说明
任务批次号	batchNO	是	String	如1,2,3

2.2 子件转换

2.2.1 首次转换接口

URL地址： http://[domain]/nds_requests/common/InsertPartConvertAddTask


接口说明
添加一条子件转换模式下的装配体首次转换任务。必须在模型文件成功上传到轻量化服务平台后，才可调用任务添加接口。上传的文件以“时间戳 + 随机数”命名，不含中文。

Table 16. 请求参数
字段名	变量名	必填	类型	说明
文件名	inputFiles	否	String	上传到FTP目录的文件名称。请填写相对路径，如“38237874832438.zip”。仅支持zip格式压缩包
Nds文件名	inputNdsFile	否	String	上传到Nds公有云存储目录的文件名称，请填写上传临时授权时返回的inputNdsFile
文件路径	inputURL	否	String	可直接提供文件下载地址。注意 inputFiles 、inputURL、inputNdsFile 必须有一个不为空
回调地址	returnURL	否	String	任务处理完成后的回调
任务优先级	priority	否	Int	默认为0，值越大，优先级越高
任务描述	taskDescription	否	String	`{ "Detail":"-1", "Detect":"1", "Brep":"1", "Mesh":"1", "Pmi":"1", "Prop":"1", "Camera":"1", "Animate":"1", "Sketch":"1" }` taskDescription为非必填，且内部参数可选填。详见任务描述说明

Table 17. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务ID

Table 18. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 19. 变量data的属性值
字段名	属性名	必填	类型	说明
任务ID	taskID	是	String	任务ID

2.2.2 更新修改接口

URL地址： http://[domain]/nds_requests/common/InsertPartConvertUpdateTask


接口说明
添加一条子件转换更新修改任务。必须在模型文件成功上传到轻量化服务平台后，才可调用任务添加接口。上传的文件以“时间戳 + 随机数”命名，不含中文。

Table 20. 请求参数
字段名	变量名	必填	类型	说明
文件名	inputFiles	否	String	上传到FTP目录的文件名称。请填写相对路径，例如“38237874832438.zip”。仅支持zip格式压缩包
Nds文件名	inputNdsFile	否	String	上传到Nds公有云存储目录的文件名称，请填写上传临时授权时返回的inputNdsFile
文件路径	inputURL	否	String	可直接提供文件下载地址。注意 inputFiles 、inputURL 、inputNdsFile 必须有一个不为空
回调地址	returnURL	否	String	任务处理完成后的回调
任务优先级	priority	否	Int	默认为0，值越大，优先级越高
任务描述	taskDescription	否	String	`{ "Detail":"-1", "Detect":"1", "Brep":"1", "Mesh":"1", "Pmi":"1", "Prop":"1", "Camera":"1", "Animate":"1", "Sketch":"1" }` taskDescription为非必填，且内部参数可选填。详见任务描述说明

Table 21. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务ID

Table 22. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 23. 变量data的属性值
字段名	属性名	必填	类型	说明
任务ID	taskID	是	String	任务ID

2.3 轻量化离线预览生成

URL地址： http://[domain]/nds_requests/common/InsertHtmlConvertTask


接口说明
添加一条轻量化数据生成离线预览html的转换任务。输入文件zip文件根目录内容包括： 1、轻量化数据文件 2、批注数据：modelTags.jsonjs调用nd_viewCtrl.nd_getAllTags方法可以获取当前批注，将该信息保存为modelTags.json 。注意文件使用utf-8格式保存 3、显示隐藏模型信息：initParam.jsonjs调用nd_viewCtrl.nd_getHideObjectidLists方法可以获取隐藏部件objectId集合信息，将该信息保存为initParam.json。注意文件使用utf-8格式保存

Table 24. 请求参数
字段名	变量名	必填	类型	说明
文件名	inputFiles	是	String	输入文件压缩包（轻量化数据及批注文件压缩包）
文件路径类型	inputType	是	Int	0: minio 1: http路径 2: ftp路径
轻量化预览类型	viewerType	是	Int	1: 3D轻量化 2: 2D轻量化 3: 自定义默认1
模型名称	modelName	否	String	模型名称,预览模型标题（空时标题显示生成html的文件名称）
自定义预览模板	viewerPath	否	String	viewerType为3时：inputFiles压缩包中viewer模板相对路径
主装文件夹路径	assemblyFolder	否	String	主装文件夹路径（子件转换轻量化数据必传，其他转换不传）
回调地址	returnURL	否	String	任务处理完成后的回调
任务优先级	priority	否	Int	默认为0，值越大，优先级越高

Table 25. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务ID

Table 26. 变量status的属性值
字段名	变量名	必填	类型	说明
返回码	code	是	String	见返回码定义
错误信息	msg	是	String	错误信息

Table 27. 变量data的属性值
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID

2.4 回调

如果任务添加的回调地址（returnURL）不为空，服务器会在任务处理完成之后，调用第三方系统地址，回传处理结果，如下：


普通转换->单条添加任务（returnType=1）
默认输出方式：输出文件路径类型配置使用Ftp输出类型 `http://[domain]/xxx?apiKeyData=[key]&shaKeyData=[key]&timeStampData=[时间戳]&returnType=1&taskID=[任务ID]&status=[任务状态]&errorDescription=[错误描述]&errorDetail=[错误信息详情]&outputFiles=[输出文件，FTP相对下载路径]&ftp=[ftpIP+端口]&ftpUserName=[ftp账号]&ftpPassword=[ftp密码]&version=[版本号]&previewURL=[模型预览访问地址] &jsonURL=[模型信息Json地址]&imgURL=[截图地址]`
输出文件路径类型配置使用NdsFile输出类型 `http://[domain]/xxx?shaKeyData=[key]&timeStampData=[时间戳]&returnType=1&taskID=[任务ID]&status=[任务状态]&errorDescription=[错误描述]&errorDetail=[错误信息详情]&outputFiles=[输出文件名称]&outFilePathType=[输出文件路径类型]&outputNdsFiles=[输出文件，临时授权下载路径]&version=[版本号]&previewURL=[模型预览访问地址]&jsonURL=[模型信息Json地址]` `shaKeyData = SHA256Encrypt(secretKey + timeStampData + taskID+ status)，SHA256加密方法见接口定义`
文件截图之后调用第三方系统地址，回传处理结果（returnType=3）
`http://[domain]/xxx?apiKeyData=[key]&timeStampData=[时间戳]&returnType=3&taskID=[任务ID]&imgURL=[截图地址]`
普通转换->多任务批量添加（returnType=2）
默认输出方式：输出文件路径类型配置使用Ftp输出类型 `http://[domain]/xxx?apiKeyData=[key]&shaKeyData=[key]&timeStampData=[时间戳] &returnType=2&batchNO=[任务ID]&status=[任务状态]&errorDescription=[错误描述]&errorDetail=[错误信息详情]&version=[版本号]&childList=[子任务信息]` 子任务信息为Json字符串,仅提供taskID和filePath信息 `[{"taskID": "1", filePath: "1/LM40UU.SLDPRT"}, {"taskID": "2", filePath: "1/a.SLDPRT"}]` `apiKeyData = MD5(secretKey + timeStampData+ batchNO + status + errorDescription + errorDetail)，MD5加密方法见接口定义` `shaKeyData = SHA256Encrypt(secretKey + timeStampData+ batchNO + status)，SHA256加密方法见接口定义`
子件转换（returnType=4）
`http://[domain]/xxx?apiKeyData=[key]&timeStampData=[时间戳] &returnType=4&taskID=[任务ID]&status=[任务状态]&errorDescription=[错误描述]&errorDetail=[错误信息详情]&outputFiles=[下载文件地址]&ftp=[ftp连接地址]&ftpUserName=[加密的ftp用户信息]&ftpPassword=[ftp加密的密码]&errorType=[错误类型]`
轻量化数据离线包转换（returnType=5）
`http://[domain]/xxx?shaKeyData=[key]&timeStampData=[时间戳]&returnType=5&taskID=[任务ID]&status=[任务状态]&errorDescription=[错误描述]&errorDetail=[错误信息详情]&outputFiles=[输出文件名称]&outFilePathType=[输出文件路径类型]&outputNdsFiles=[输出文件，临时授权下载路径]&errorType=[错误类型]` `shaKeyData = SHA256Encrypt(secretKey + timeStampData + taskID+ status)，SHA256加密方法见接口定义`

其中 http://[domain]/xxx 为第三方传入地址。

Table 28. 参数说明
回调描述参数	说明
apiKeyData	参考 apiKeyData签名生成方法
timeStampData	参考 timeStampData签名生成方法
returnType	回调类型 1：普通转换->单条添加任务 2：普通转换->多任务批量添加 3：截图回调 4：子件转换 5：轻量化离线转换
taskID / batchNO	任务ID
status	任务状态
errorDescription	错误描述
errorDetail	错误信息详情
errorType	错误类型 (见错误信息定义)
outFilePathType	输出文件路径类型（1：ndsFile 0：FtpFile）
outputNdsFiles	输出文件，临时授权下载路径，Nds云文件服务路径（http路径）
outputFiles	输出文件，FTP相对下载路径
ftp	输出文件下载 ftp IP+端口
ftpUserName	输出文件下载 ftp账号
ftpPassword	输出文件下载 ftp密码
version	版本号
previewURL	模型预览访问地址
jsonURL	模型信息Json url地址
imgURL	截图url地址
childList	子任务信息-eg： `[{"taskID": "1", filePath:"1/LM40UU.SLDPRT"}, {"taskID": "2", filePath: "1/a.SLDPRT"}] apiKeyData = MD5(secretKey + timeStampData + batchNO+ status + errorDescription + errorDetail)`

3. 任务查询接口

3.1 单任务查询接口

URL地址： http://[domain]/nds_requests/common/QueryTask


接口说明
在任务插入成功，获取到taskID之后，根据taskID轮询一次任务，获取任务详细信息。当返回的任务状态为 “0”（待处理）或者 “1”（处理中）时，继续轮询。当返回的任务状态为 “2”（处理成功）或者其他时，停止轮询，根据返回结果处理业务逻辑。

Table 29. 请求参数
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID

Table 30. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务详细信息

Table 31. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 32. 变量data的属性值
字段名	属性名	必填	类型	说明
任务状态	status	是	String	任务状态，见5.3 任务状态定义
错误描述	errorDescription	是	String	错误描述
错误详细信息	errorDetail	否	String	错误详细信息
输出文件路径	outputFiles	否	String	输出文件FTP路径
输出路径类型	outFilePathType	是	Int	1：NdsFile 0：ftpFile。两种类型同时只存在一个
NdsFile-输出路径	outputNdsFiles	否	String	输出文件临时下载路径，通过base64编码
ftpFile-ftp地址	ftp	是	String	访问输出文件的FTP地址
ftpFile-ftp用户名	ftpUserName	是	String	用于下载FTP文件的用户名
ftpFile-ftp密码	ftpPassword	是	String	用于下载FTP文件的密码
转换错误类型	errorType	否	Int	见错误信息定义
模型预览访问地址	previewURL	否	String	模型预览地址通过base64编码
模型信息 Json 地址	jsonURL	否	String	模型信息 Json 地址通过base64编码
截图地址	imgURL	否	String	截图地址通过base64编码
模型轻量化地址	OutputLightData	否	String	地址通过base64编码

3.2 单任务查询任务详细接口

URL地址： http://[domain]/nds_requests/common/QueryTaskDetail


接口说明
在任务插入成功，获取到taskID之后，根据taskID轮询一次任务，获取任务详细信息。当返回的任务状态为“0”（待处理）或者“1”（处理中）时，继续轮询。当返回的任务状态为“2”（处理成功）或者其他时，停止轮询，根据返回结果处理业务逻辑。

Table 33. 请求参数
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID

Table 34. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务详细信息

Table 35. 变量status的属性值
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID
返回码	code	是	String	见返回码定义
错误信息	msg	是	String	错误信息

Table 36. 变量data的属性值
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID
任务状态	status	是	String	任务状态，见任务状态定义
错误描述	errorDescription	是	String	错误描述
错误详细信息	errorDetail	否	String	错误详细信息
输出文件路径	outputFiles	否	String	输出文件FTP路径
输出路径类型	outFilePathType	是	Int	1：NdsFile 0：ftpFile 两种类型同时只存在一个
NdsFile-输出路径	outputNdsFiles	否	String	输出文件临时下载路径，通过base64编码
ftpFile-ftp地址	ftp	是	String	访问输出文件的FTP地址
ftpFile-ftp用户名	ftpUserName	是	String	用于下载FTP文件的用户名
ftpFile-ftp密码	ftpPassword	是	String	用于下载FTP文件的密码
转换错误类型	errorType	否	Int	见错误信息定义
模型预览访问地址	previewURL	否	String	模型预览地址通过base64编码
模型信息Json地址	jsonURL	否	String	模型信息Json地址通过base64编码
截图地址	imgURL	否	String	截图地址通过base64编码
转换文件名	inputFileName	是	String	上传转换的文件名，包括后缀信息
转换时间	convertTime	是	Int	转换总耗时，单位秒（s）
原数据大小	inputFileSize	是	Int	输入文件大小（kb）
轻量化文件大小	outputFileSize	是	Int	输出文件大小（kb）
轻化比	convertPercent	是	String	模型轻量化比
模型类型	taskType	是	Int	10：3D转换；9：2D转换；23：子件转换
三角面片数量	triangleNum	是	String	三角面片数量

3.3 单任务查询模型详细接口

URL地址： http://[domain]/nds_requests/common/QueryTaskModelInfo


接口说明
在任务插入成功，获取到taskID之后，根据yunapi服务配置”NeedDataAnalysis”，是否处理轻量化模型解析 (值为1时会处理,默认不处理)，获取模型结构，PMI,属性信息等，并保存为对应json文件到轻量化预览地址中。信息保存成功后，调用该接口返回获取的信息的json文件url访问地址数组。

Table 37. 请求参数
字段名	变量名	必填	类型	说明
任务ID	taskID	是	String	任务ID

Table 38. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务详细信息

Table 39. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 40. 变量data的属性值（数组结构）
字段名	属性名	必填	类型	说明
结构信息路径	modelInfoURL	是	String	模型信息json文件访问url地址
PMI信息路径	pmiInfoURL	是	String	Pmi信息json文件访问url地址
属性信息路径	propertyInfoURL	是	String	属性信息json文件访问url地址

3.4 批量任务查询接口

URL地址： http://[domain]/nds_requests/common/QueryMultiTask


接口说明
将多个taskID使用英文逗号“,”拼接成参数，请求接口获取查询结果，查询结果数组和taskList为一一对应关系

Table 41. 请求参数
字段名	变量名	必填	类型	说明
任务ID	taskList	是	String	使用英文逗号“,”拼接多个taskID

Table 42. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务详细信息

Table 43. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 44. 变量data的属性值（数组，单个对象结构）
字段名	属性名	必填	类型	说明
任务状态	status	是	String	任务状态，见5.3 任务状态定义
错误描述	errorDescription	是	String	错误描述
错误详细信息	errorDetail	否	String	错误详细信息
输出文件路径	outputFiles	否	String	输出文件名称
输出路径类型	outFilePathType	是	Int	1：NdsFile 0：ftpFile。两种类型同时只存在一个
NdsFile-输出路径	outputNdsFiles	否	String	输出文件临时下载路径，通过base64编码
ftpFile-ftp地址	ftp	是	String	访问输出文件的FTP地址
ftpFile-ftp用户名	ftpUserName	是	String	用于下载FTP文件的用户名
ftpFile-ftp密码	ftpPassword	是	String	用于下载FTP文件的密码
转换错误类型	errorType	否	Int	见5.4 错误信息描述
模型轻量化地址	outputLightData	否	String	地址通过base64编码

3.5 根据任务批次查询任务列表接口

URL地址： http://[domain]/nds_requests/common/QueryBatchTask


接口说明
在任务插入成功，获取到taskID之后，根据taskID轮询一次任务，获取任务详细信息。当返回的任务状态为 “0”（待处理）或者 “1”（处理中）时，继续轮询。当返回的任务状态为 “2” 或者其他时，停止轮询，根据返回结果处理业务逻辑。

Table 45. 请求参数
字段名	变量名	必填	类型	说明
任务批次号	batchNO	是	String	调用多任务批量添加接口后获取

Table 46. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息
接口数据	data	是	json	接口的返回数据，包含任务详细信息

Table 47. 变量status的属性值
字段名	属性名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

Table 48. 变量data的属性值
字段名	属性名	必填	类型	说明
任务状态	status	是	String	任务状态，见5.3 任务状态定义
错误描述	errorDescription	是	String	错误描述
错误详细信息	errorDetail	否	String	错误详细信息
ftpFile-ftp地址	ftp	是	String	访问输出文件的FTP地址
ftpFile-ftp用户名	ftpUserName	是	String	用于下载FTP文件的用户名
ftpFile-ftp密码	ftpPassword	是	String	用于下载FTP文件的密码
任务类型	taskType	是	Int	见任务类型定义
服务版本号	version	否	String	转换服务版本号
转换错误类型	errorType	否	Int	见错误信息定义
子任务信息	childList	否	List	子任务信息，数组中对应定义见变量 childList 的对象属性值

Table 49. 变量 childList 的对象属性值
字段名	属性名	必填	类型	说明
子任务ID	taskID	是	Int	任务ID，可通过任务查询接口单独查询该任务状态
文件路径	filePath	是	String	文件在上传的压缩包中的相对路径，如`文件夹1/LM40UU.SLDPRT`
任务状态	status	是	String	任务状态，见5.3 任务状态定义
错误描述	errorDescription	是	String	错误描述
错误详细信息	errorDetail	否	String	错误详细信息
输出文件路径	outputFiles	否	String	输出文件FTP路径
输出路径类型	outFilePathType	是	Int	1：NdsFile 0：ftpFile
NdsFile-输出路径	outputNdsFiles	否	String	输出文件临时下载路径，通过base64编码
转换错误类型	errorType	否	Int	见5.4 错误信息描述

4. 任务取消接口

URL地址： http://[domain]/nds_requests/common/RemoveTask


接口说明
取消任务。调用接口时传递任务ID，可以取消任务。

Table 50. 请求参数
字段名	变量名	必填	类型	说明
任务ID集合	taskList	是	String	任务ID集合，如1, 2, 3

Table 51. 返回参数
字段名	变量名	必填	类型	说明
接口状态	status	是	json	接口的调用状态，包含接口返回码和错误信息

Table 52. 变量status的属性值
字段名	变量名	必填	类型	说明
返回码	code	是	String	见5.1 返回码定义
错误信息	msg	是	String	错误信息

5. 枚举值列表

5.1 返回码定义

Table 53. 返回码定义
返回值	返回值说明
1	成功
-1	程序错误
-2	不合法的许可服务证书
-3	不合法的签名/签名验证失败
-4	缺少参数
-6	任务状态已变更
-7	不合法的ip请求地址
-999	程序异常

5.2 任务描述说明

Table 54. 任务描述说明
任务描述参数	说明
Detail	几何数据离散精度。 -1：默认精度； 0：低精度； 1：中精度； 2：高精度；默认为-1
Brep	是否导出边界数据。 0：不导出； 1：导出；默认为1
Mesh	网格简化精度。 0：低精度； 1：中精度； 2：高精度；默认为1
PMI	是否导出PMI注释数据。 0：不导出； 1：导出；默认为1
Prop	是否导出属性数据。 0：不导出； 1：导出；默认为1
Camera	是否导出相机数据。 0：不导出； 1：导出；默认为1
Animate	是否导出动画数据。 0：不导出； 1：导出；默认为1
Sketch	是否输出草图信息。 0：不输出； 1：输出；默认为0

5.3 任务状态定义

Table 55. 任务状态定义
任务状态	任务状态说明
0	待处理
1	处理中
2	处理完成
3	等待超时
4	处理超时
5	处理失败
6	任务取消

5.4 错误信息描述

Table 56. 错误信息描述
错误代码	错误类型	错误描述信息
1	正常	-
-1	文件异常	如：文件下载错误 /文件无法打开 / 文件上传失败等等
-2	任务处理失败	如：文件转换失败 / 零件造型失败 / 页面静态化失败等等
-3	文件转换超时	如：文件转换超时 / 零件造型超时 / 页面静态化超时等等
-4	授权失败	如：授权过期 / 没有授权文件等等
-5	错误的文件	如：输入的CAD文件本身的内容错误等等
-6	版本不支持的模型文件	如：CAD文件的类型和版本有限制，比如支持CATIA支持版本为V5–V6R2017，不在这个版本内会打开失败；不支持的格式如rvt、Z3等
-7	模型文件无几何内容	如：输入的CAD文件没有任何几何内容等等
-8	不支持的数据导出格式	如：比如CAD文件没有Body，只画了一个点，这样的数据无法导出来等等