文档

GetWorkitemAttachmentCreatemeta - 获取工作项上传附件的信息

获取工作项附件上传的信息接口,这是工作项上传附件中的第一步。整个过程需要完成三步, 第一步,调用该接口获取工作项的上传信息。 第二步,根据该接口的返回信息将文件上传到oss中。 第三步,将文件作为工作项的附件,对应的接口为 WorkitemAttachmentCreate(关联文件为工作项的附件) 第二步上传文件时可以参考oss的文档:https://help.aliyun.com/document_detail/31926.html, 注意请求为POST方法,数据是表单提交的方式。

接口说明

第二步的调用示例:

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/workitem/{workitemIdentifier}/attachment/createmeta

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

60de7a6852743a5162b5f957
workitemIdentifierstring

工作项 id,同 workItemId,工作项唯一标识

11234455454355
fileNamestring

需要上传的文件完整名称

application.jar

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

Invalid.IdNotFound
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

Forbidden.UserNotInCurrentOrganization
successstring

true 接口调用成功,false 接口调用失败

true
uploadInfoobject

可参考 OSS 的文档:https://help.aliyun.com/document_detail/31926.html

accessidstring

上传的认证信息,设置到上传时的 OSSAccessKeyId

xxxxxxx
policystring

上传的认证信息

xxxxxxx
signaturestring

上传的认证信息

xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=
dirstring

上传的认证信息,对应到上传时为 key

ddd/dddd
hoststring

上传文件的地址

xxxxx

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Invalid.IdNotFound",
  "errorMessage": "Forbidden.UserNotInCurrentOrganization",
  "success": "true",
  "uploadInfo": {
    "accessid": "xxxxxxx",
    "policy": "xxxxxxx",
    "signature": "xdWcrl/yTmIUA0kE7a3B0Ox4Vu8=",
    "dir": "ddd/dddd",
    "host": "xxxxx"
  }
}

错误码

HTTP status code错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

  • 本页导读 (0)
文档反馈