查询文件详情 | 大装置帮助中心
跳到主要内容

查询文件详情

接口描述（Description）​

查询文件详情


请求地址（Request URL）​

[GET] https://file.sensenova.cn/v1/files/{file_id}

请求头（Request Header）​

无特殊Header，请参考接口鉴权


请求参数（Path Parameters）​

名称类型必须默认值可选值描述
file_idstring是--文件ID

请求示例（Request Example）​

curl --request GET "https://file.sensenova.cn/v1/files/{file_id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_TOKEN"

响应（Response）​

名称类型描述
fileobject文件详情
  • file 部分参数如下：
名称类型描述
idstring文件ID
descriptionstring文件描述
schemestring文件格式
created_atstring文件创建时间，ISO 8601标准时间格式，精确到纳秒
updated_atstring文件更新时间，ISO 8601标准时间格式，精确到纳秒
statusstring文件状态，枚举值
未上传/上传中：NOTUPLOADED
已上传（等待格式校验）：UPLOADED
文件无效（格式校验不通过）：INVALID
文件有效（格式校验通过）：VALID
file_namestring文件名称
validate_resultstring文件校验结果

响应示例（Response Example）​

{
  "file":{
    "id": "string", 
    "description": "string",
    "scheme": "string",
    "created_at": "2023-06-28T17:23:01.243566533Z", 
    "updated_at": "2023-06-28T17:23:01.243566533Z",
    "status": "string", 
    "file_name": "string",
    "validate_result": "string"
  }   
}

错误信息​

参考错误码