重庆市BIM项目管理平台对接流程及接口标准

-1-重庆市BIM项目管理平台对接流程及接口标准参数名定义说明HOSTURL接口地址BIM接口地址1.获取Token认证接口规范接口地址/token接口说明通过用户名、密码获取BIM施工应用接口的统一身份授权认证参数格式application/x-www-form-urlencoded请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明usernamevarchar是下发帐号passwordvarchar是下发密码返回结果示例{"access_token":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjQzQkVDNUZDOEJFNEVEMTI1M0EwQUFFOTU4MjY5Rjc5QjQ3MzdBMjMiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJRNzdGX0l2azdSSlRvS3JwV0NhZmViUnplaU0ifQ.eyJuYmYiOjE1OTc5OTIxMzAsImV4cCI6MTU5Nzk5NTczMCwiaXNzIjoiaHR0cHM6Ly9pZC5zcGRzcGQuY29tIiwiYXVkIjpbImh0dHBzOi8vaWQuc3Bkc3BkLmNvbS9yZXNvdXJjZXMiLCJGaWxlU2VydmVyIiwiaWRlbnRpdHkiLCJKd0ZpbGVMaWJyYXJ5IiwiTVBQIl0sImNsaWVudF9pZCI6IlRlc3RKd0ZpbGUiLCJzdWIiOiI3ZTg3YjJhMC0wZTY1LTRiNmMtYTk0My0xYTc5MTUwOTNhOGQiLCJhdXRoX3RpbWUiOjE1OTc5OTIxMzAsImlkcCI6ImxvY2FsIiwibmFtZSI6IlNQRENJIiwicGhvbmVfbnVtYmVyIjoiMTg4ODg4ODg4ODgiLCJyb2xlIjoiQ3VzdG9tZXIiLCJzY29wZSI6WyJvcGVuaWQiLCJwcm9maWxlIiwiRmlsZVNlcnZlciIsImlkZW50aXR5IiwiSndGaWxlTGlicmFyeSIsIk1QUCJdLCJhbXIiOlsicHdkIl19.1F-tKl-gJLnsFEpdEcGJngNeO3D9E0t5AEKwvVA-D4jIETFBxDa3A3mQMGfX34bd2LKdh_xy9PgAgAVW5SLfzmzBWUZ9xJGGrMZ6DcPjKJBhhccLFGSd1OSQtVKk31uZgeTlMejsXR7P1ukQ9q3wihjFi0VPSqcUyrO_Jox890zm0ai4cmUWPATKxhPDuBBnkNkMpqUhYC0GPfMgmbSxz68FWThv94KjXOrr7Lamug0CLwf9bHiiJJzPOUoDg3Sm3UjXZHHBxF-TaroiSX3aoqdxV0hiYswmhHu_ONbmu3BOISEtJQ0UcwQgxCLxGtqFTOpugROxjkO3QMv52Q5C1g","expires_in":3600,"token_type":"Bearer","scope":"FileServeridentityJwFileLibraryMPPopenidprofile"}2.查询模型文件上传状态接口规范接口地址{HOSTURL}/api/v1/FlowJs/UploadFileStatus接口说明查询文件的上传状态参数格式…/UploadFileStatus?hash=43263f40d02aaa2c4b82d8d5c786df88&totalChunks=-1请求方法getHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明hashvarchar是文件hashtotalChunksvarchar是-1返回结果示例{"item":{"hash":"43263f40d02aaa2c4b82d8d5c786df88","status":2,"file":{"id":"45965c2e-3cd3-4c6d-9183-ea779066b33b","name":"sendorder_202008192259324212.pdf","path":"db876c2a-fb71-45df-a1e3-022eb52d8257/00000000-0000-0000-0000-000000000000/43263f40d02aaa2c4b82d8d5c786df88.pdf","createdUserId":"db876c2a-fb71-45df-a1e3-022eb52d8257","hash":"43263f40d02aaa2c4b82d8d5c786df88","createdUserName":"小蛛","type":".pdf","size":29531,"createdAt":"2020-08-19T14:59:57.168Z","url":"/db876c2a-fb71-45df-a1e3-022eb52d8257/00000000-0000-0000-0000-000000000000/43263f40d02aaa2c4b82d8d5c786df88.pdf","tags":["System.String[]"]},"unUploadChunks":null},"success":true,"code":200}3.模型文件上传接口规范接口地址{HOSTURL}/api/v1/FlowJs/Upload接口说明文件上传,支持断点续传，切片上传参数格式content-type:multipart/form请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明fileNamestring是-1文件名fileExtentionstring是-1文件类型fileHashstring是-1文件Hash加密值fileSizeInt是32文件大小totalChunksInt是32切片总数chunkNumberInt是32当前上传切片序号currentChunkSizeInt是32当前切片大小tagsString[]是0[]返回结果示例{

"item":{

"id":"a4ab927f-4f10-4921-8333-6836c7e207f9",

"name":"1.rvt",

"path":"c43e4b52-f152/.../4917c47c8614ceec7cacddc7e408604f.rvt",

"createdUserId":"c43e4b52-f152-4b16-a1e8-880fb1af165e",

"hash":"4917c47c8614ceec7cacddc7e408604f",

"createdUserName":"筑业",

"type":".rvt",

"size":5918720,

"createdAt":"2019-11-13T09:38:20.1641803+08:00",

"url":":6010/c43e4b52/.../4917c47c8614ceec7cacddc7e408604f.rvt",

"tags":[

"110101",

"ARCHIVAL_PHASE",

"BUILDING"

]

},

"success":true,

"code":200}补充说明如果在查询上传状态时出现返回status=1，unUploadChunks数组为空的状况，说明文件切块已经全部上传完毕，但是文件却没有完成合并,这时无需切块，直接将ChunkNumber=-1，CurrentChunkSize=0，后调用此接口，后台会判断这个参数，并将其合并模型文件同步接口规范接口地址{HOSTURL}/api/v1/FlowJs/Synchronous接口说明当文件上传转台status!=2时，调用此接口完成文件同步参数格式content-type:application/x-www-form-urlencoded请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明hashstring是-1文件Hash加密值返回结果示例{

"item":{

"hash":"baf118c5a2b52c045917ba26a362bdfa",

"status":2,

"file":{

"id":"d4e486a1-305d-4268-bc3e-0171f1f911ea",

"name":"9.rvt",

"path":"afae5063-daee-4bb0-b67e-325f65767f1c/3.../baf118c5a2b52c045917ba26a362bdfa.rvt",

"createdUserId":"afae5063-daee-4bb0-b67e-325f65767f1c",

"hash":"baf118c5a2b52c045917ba26a362bdfa",

"createdUserName":"访客",

"type":".rvt",

"size":5943296,

"createdAt":"2019-06-18T18:15:45",

"url":":6010/afae5063-da/.../baf118c5a2b52c045917ba26a362bdfa.rvt",

"tags":null

},

"unUploadChunks":null

},

"success":true,

"code":200}模型转换接口规范接口地址{HOSTURL}/api/v1/FileConvert/convert-model接口说明当模型文件上传完成，请求转换接口完成轻量化参数格式content-type:application/json请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明modelGroupIdguid是链接模型组标识IDfileList[]是转换的文件集合返回结果示例{

"item":{

"id":"7ded18cb-155b-47ec-b077-2a34dca59dd6",

"projectId":"bd414a32-cb14-407c-8833-47915d5",//模型组ID(ModelGroupId)

"taskId":"78842c39-d40f-4592-9fbe-4502f72caa19",//任务Id

"modelList":[

{

"id":"00000000-0000-0000-0000-000000000000",

"modelGroupId":null,

"taskId":null,

"modelId":0,

"modelName":"revit模型（场地建筑）.rvt",

"modelPath":null,

"hash":"9ed4dae5136b19f5b73a6b895fce3cc5",

"percent":0,

//文件转换进度

"errorMessage":""

//错误信息

}

],

"taskState":{

"found":true,//文件是否存在

"done":false,//转换是否完成

"successed":true,//任务是否成功执行

"message":"开始转换模型!"

},

"createdAt":"2019-11-13T08:58:18.2403385+08:00"

},

"success":true,

"code":200}补充说明参数说明：fileList：

[

{"id":"e7288b23-8e54...",

"Name":"revit模型.rvt",

"Type":".rvt",

"Size":10080256,

"Hash":"9ed4dae5136b19f5b73...",

"Path":"c43e4b52-...e3cc5.rvt",

"Tags":[

"500103",

"ARCHIVAL_PHASE",

"BUILDING"

]}

]模型转换状态查询接口规范接口地址{HOSTURL}/api/v1/FileConvert/convert-process接口说明当模型文件发起转换成功后，请求该接口查询转换状态参数格式convert-process?modelGroupId=b557f392-7631-4946-ba59-2c1d969bce5c&taskId=cc4044bc-be1d-40bc-82db-f47681828785请求方法getHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…参数详情参数名数据格式是否必须 长度说明modelGroupIdguid是链接模型组标识IDtaskIdguid是转换标识返回结果示例{"item":{"id":"839f145d-7de5-4d8d-9236-706e84c3d07c","projectId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelList":[{"id":"2fc38fc9-2a58-451f-b662-afbfd1f55859","modelGroupId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelId":0,"modelName":"重庆建工职学院-建筑建模.RVT","modelPath":null,"hash":"c013c7379021cd809c2fa1c277b68e99","percent":0,"errorMessage":"ParseModelError"},{"id":"c574b626-cef7-49bc-886e-447b75ec220f","modelGroupId":"b557f392-7631-4946-ba59-2c1d969bce5c","taskId":"cc4044bc-be1d-40bc-82db-f47681828785","modelId":0,"modelName":"木洞风貌改造施工图设计_3#_土建.RVT","modelPath":null,"hash":"3e2c9d40b449321c7f76663a452cdbcd","percent":0,"errorMessage":"ParseModelError"}],"taskState":{"found":true,"done":true,"successed":true,"message":""},"createdAt":"2020-08-27T12:11:52.0687634+08:00"},"success":true,"code":200}补充说明创建项目信息记录接口规范接口地址{HOSTURL}/bim/api/v2/project/create接口说明创建项目参数格式json请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…bimapikeystring是bim对接密钥参数详情参数名数据格式是否必须 长度说明idguid是项目标识guidcodestring是项目编号namestring是项目名称addressstring否地址gAreaCodestring是区域编码(选项)typeInt是项目类型(选项)stageInt是项目阶段(选项)rateInt是项目进度(选项)statusint是项目状态(选项)finishDatedate否工程结束时间startDatedate否工程开始时间参数示例{ "Name":"testproject003", "Code":"testproject003", "AreaCode":"500004", "Type":10, "Stage":1}返回结果示例{"result":"5477a67d-3f95-40a9-8238-20ce55dbebce",//创建成功项目标识guid"targetUrl":null,"success":true,"error":null,"unAuthorizedRequest":false,"__abp":true}补充说明(选项)字段数据字典可调用14.12接口进行查询创建项目模型组记录接口规范接口地址{HOSTURL}/bim/api/v2/projectGroup/create接口说明创建项目模型组参数格式json请求方法postHeader区参数参数名参数类型是否必须说明AuthorizationString是Bearer[空格]eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk3MDFmNjc3Y2UyZj…bimapikeystring是bim对接密钥参数详情参数名数据格式是否必须 长度说明idguid是ModelGroupIdnamestring是组名称projectIdstring否所属项目标识IdtaskIdstring是请求转换成功的taskid参数示例{ "Id":"04c69dbf-e710-4fe3-af8b-a0e4cdadee83", "Name":"测试创建项目场景A", "ProjectId":"9e554c6b-8cb2-4f53-97d0-ddc3acc56ec7", "TaskId":"42862c4e-0f25-4512-9ec8-a45a46248b1a","ParentModelGroupId":"0000-00000-00000-00000-000"//上级场景标识}返回结果示例{"result":"04c69dbf-e710-4fe3-af8b-a0e4cdadee83",//创建成功后的modelgroupid"targetUrl":null,"success":true,"error":null,"unAuthorizedRequest":false,"__abp":true}补充说明创建项目模型记录接口规范接口地址{HOSTURL}/bim/