GetWorkitemFile,获取工作文件信息-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
项目协作	工作项附件	只读

请求语法

中心版

GET https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{workitemId}/files/{id}

Region版

GET https://{domain}/oapi/v1/projex/workitems/{workitemId}/files/{id}

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	organizationId。
workitemId	string	path	是	工作项唯一标识。
id	string	path	是	文件唯一标识。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{workitemId}/files/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/workitems/{workitemId}/files/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object
id	string	id。	id-xxx
name	string	名称。	name-xxx
size	integer	大小。	1024
suffix	string	后缀。	.png
url	string	文件下载地址，是个临时的下载地址，有实效性。	https://xxx.test.com

返回示例

{
    "id": "id-xxx",
    "name": "name-xxx",
    "size": 1024,
    "suffix": ".png",
    "url": "https://xxx.test.com"
}

错误码

访问错误码中心查看 API 相关错误码。