GetWorkitemFile - 获取工作项文件信息_云效(Apsara Devops)-阿里云帮助中心

获取工作项的文件信息，例如工作项的描述中的图片信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/workitem/{workitemIdentifier}/files/{fileIdentifier}

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	60811b5eed6e867404f6xxxx
workitemIdentifier	string	是	工作项 id，唯一标识	11234455454355
fileIdentifier	string	是	文件唯一标识	dfsdfdsgdsfdsfff

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息	error
errorCode	string	错误码	success
success	string	true 接口调用成功，false 接口调用失败	true
workitemFile	object	文件对象
id	string	文件 id	sddrdfdf123df
name	string	文件名称	ddc.pdf
suffix	string	文件扩展名	pdf
size	integer	文件内容大小，单位：bytes	10001
url	string	下载的 url	http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "success",
  "success": "true",
  "workitemFile": {
    "id": "sddrdfdf123df",
    "name": "ddc.pdf",
    "suffix": "pdf",
    "size": 10001,
    "url": "http://tmaestro-oss.oss-cn-hongkong.aliyuncs.com/thread_1682129288279.log"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParam.ParamNotPresent	The parameter is invalid.	参数有误，请检查参数
404	InvalidOrganization.NotFound	The organization is not found.	企业不存在，请检查企业ID是否正确

访问错误中心查看更多错误码。