C#开发BIMFACE系列7 服务端API之获取文件信息列表

系列目录     【已更新最新开发文章，点击查看详细】

本文详细介绍如何获取BIMFACE平台中所有上传过的文件信息列表。

请求地址：GET https://file.bimface.com/files

说明：根据多种查询条件获取文件详细信息列表，支持分页

参数：

请求 path(示例)：https://file.bimface.com/files

请求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"

HTTP响应示例(200)：

{
  "code" : "success",
  "data" : [ {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  } ],
  "message" : ""
}

注意上面返回的data内容是一个数组。

C#实现方法：

/// <summary>
///  根据多种查询条件获取文件详细信息列表，支持分页
/// </summary>
/// <param name="accessToken">令牌</param>
/// <param name="startTime">起始日期,格式为 yyyy-MM-dd。默认为空，查询所有</param>
/// <param name="endTime">截止日期,格式为 yyyy-MM-dd。默认为空，查询所有</param>
/// <param name="rows">查询结果数, 默认为100， 最大500。默认100</param>
/// <param name="offset">查询结果偏移，从查询结果的第offset条开始返回数据。默认-1，查询所有</param>
/// <param name="status">文件状态,uploading，success，failure。默认为空，查询所有</param>
/// <param name="suffix">文件后缀。默认为空，查询所有</param>
/// <returns></returns>
public virtual FileInfoListGetResponse GetFileInfoList(string accessToken, string startTime = "", string endTime = "", long rows = 100, long offset = -1, string status = "", string suffix = "")
{
    FileInfoListGetResponse response = new FileInfoListGetResponse();
   
    #region 校验
    if (rows < 0 || rows > 500)
    {
        response.Message = "参数[rows]超出范围。要求控制在1到500之间！";

        return response;
    }

    #endregion

    //GET https://file.bimface.com/files
    string url = BimfaceConstants.FILE_HOST + "/files";
    url = url + "?rows=" + rows;
    if (!string.IsNullOrWhiteSpace(startTime))
    {
        url = url + "?rows=" + rows;
    }
    if (!string.IsNullOrWhiteSpace(endTime))
    {
        url = url + "?endTime=" + endTime;
    }
    if (offset >= 0)
    {
        url = url + "?offset=" + offset;
    }
    if (!string.IsNullOrWhiteSpace(status))
    {
        url = url + "?status=" + status;
    }
    if (!string.IsNullOrWhiteSpace(suffix))
    {
        url = url + "?suffix=" + suffix;
    }

    BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
    headers.AddOAuth2Header(accessToken);

    try
    {
        HttpManager httpManager = new HttpManager(headers);
        HttpResult httpResult = httpManager.Get(url);
        if (httpResult.Status == HttpResult.STATUS_SUCCESS)
        {
            response = httpResult.Text.DeserializeJsonToObject<FileInfoListGetResponse>();
        }
        else
        {
            response = new FileInfoListGetResponse
            {
                Message = httpResult.RefText
            };
        }

        return response;
    }
    catch (Exception ex)
    {
        throw new Exception("[获取文件信息列表]发生异常！", ex);
    }
}

其中引用的 httpManager.Get() 方法，请参考《C#开发BIMFACE系列6 服务端API之获取文件信息》，方法完全一样。

测试

在BIMFACE的控制台中可以看到我们上传的文件列表，共计2个文件。

下面通过调用上述的GetFileInfoList()方法来测试，结果如下，与后台的文件列表一致。

测试程序如下：

// 获取文件信息列表
protected void btnGetFileList_Click(object sender, EventArgs e)
{
    txtFileInfo.Text = string.Empty;

    string token = txtAccessToken.Text;

    FileApi api = new FileApi();
    FileInfoListGetResponse response = api.GetFileInfoList(token);

    List<FileInfoGetEntity> fileInfoList = response.Data;
    StringBuilder sbFiles = new StringBuilder();
    foreach(FileInfoGetEntity fileInfo in fileInfoList)
    {
        sbFiles.AppendLine("名称：" + fileInfo.ToString());
    }

    txtFileInfo.Text = response.Code
                     + Environment.NewLine
                     + response.Message
                     + Environment.NewLine
                     + "共获取 " + fileInfoList.Count + " 个文件。"
                     + Environment.NewLine
                     + sbFiles;
}

系列目录     【已更新最新开发文章，点击查看详细】