Skip to main content

Resource

danger

ONES API 已废弃。请使用Open API。

通用说明​

API 说明​

model​

resource​

资源模型

参数名参数类型取值范围说明
typestringtype资源类型
sourcestring"",edit,page图片来源, "edit": 编辑器, "page": 页面, 为了兼容之前版本, 默认值为 page
namestring字符个数 [0,255)资源 name
hashstringlen=28hash 值(可以留空或者省略)
计算方法可以参照七牛相关文档和各平台示例
ref_typestring当 type=attachment 时值 ref_type 之一
ref_idstring对应 ref_type 的 uuid
ignore_noticebool是否忽略通知
descriptionstring字符个数 [0,64)描述

type​

资源类型

取值范围mime limit说明
avatarimage/*用户头像,大小限制5MB
team_logoimage/*团队 logo,大小限制5MB
attachment*任务/消息附件，能上传任意类型的文件，大小限制50MB
jira_backupapplication/zip
confluence_backupapplication/zip
wordapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentword 文件
word_zipapplication/zipword 压缩文件

reftype​

当 type=attachment 时，ref_type

取值范围说明
project项目附件
milestone里程碑附件
task工作项附件
spacewiki 附件
user用户附件
jirajira 附件

1. 上传资源​

附件分为公开资源，和非公开资源。

公开资源指已上传到服务器上的公开资源文件。

非公开资源：需要调用资源上传接口上传文件。

URL​

https://your-host-name/project/api/project/team/:teamUUID/res/attachments/upload

请求类型​

POST

请求参数​

resource

返回参数列表​

参数名参数类型说明
need_uploadbool是否需要上传文件
base_urlstring
upload_urlstring上传地址
tokenstringtoken
resource_uuidstring资源 UUID
size_limitintsize
filefile文件描述

file

参数名参数类型说明
hashstring资源 hash
urlstring资源地址
namestringname
sizeintsize
mimestringmime

请求参数参考​

{
  "type": "avatar",
  "name": "IMG_3422.jpg",
  "hash": "FrZolWudsknm8xvTre8C58TXVGhw"
}
{
  "type": "team_logo",
  "name": "IMG_3422.jpg",
  "hash": "re8C58TXVGhwFrZolWudsknm8xvT"
}
{
  "type": "attachment",
  "ref_type": "project",
  "ref_id": "VcbR2ORJG1lPWlTq",
  "name": "example.ppt",
  "hash": "FhafioiyVcbR2ORJG1lPWlTqT8Tn"
}
{
  "type": "jira_backup",
  "ref_type": "jira",
  "name": "jira_backup.zip"
}

返回值参考​

公开资源，比如 avatar，需要上传的情况

{
  "need_upload": true,
  "base_url": "http://7xshmn.com1.z0.glb.clouddn.com",
  "token": "IOS8geS4mumCrnzln5/lkI0KOi0tLS0tfDotLS0tLQrohb7orq98IHFxLmNvbQrnvZHmmJN8IDE2My5jb20K6Zi...",
  "upload_url": "https://up.qbox.me"
}

非公开资源，比如 attachment，需要上传的情况

{
  "need_upload": true,
  "base_url": "http://7xshmo.com2.z0.glb.qiniucdn.com",
  "token": "IOS8geS4mumCrnzln5/lkI0KOi0tLS0tfDotLS0tLQrohb7orq98IHFxLmNvbQrnvZHmmJN8IDE2My5jb20K6Zi...",
  "resource_uuid": "6cLx85AV",
  "upload_url": "https://up.qbox.me"
}

公开资源，比如 avatar，不需要上传的情况

{
  "need_upload": false,
  "file": {
    "hash": "FrZolWudsknm8xvTre8C58TXVGhw",
    "url": "http://7xshmn.com1.z0.glb.clouddn.com/FrZolWudsknm8xvTre8C58TXVGhw",
    "name": "IMG_3422.jpg",
    "size": 60378,
    "mime": "image/jpeg"
  }
}

非公开资源，比如 attachment，不需要上传的情况

{
  "need_upload": false,
  "resource_uuid": "6cLx85AV",
  "file": {
    "hash": "FhafioiyVcbR2ORJG1lPWlTqT8Tn",
    "url": "http://7xshmo.com2.z0.glb.qiniucdn.com/FhafioiyVcbR2ORJG1lPWlTqT8Tn?e=1458840222&token=OxDaCSJ45X9iu9rKxVuHm6SmSP3G6D4uEah1HBaZ:aHEoPUjV7zSvZt7I83jmZkV_Irc",
    "name": "example.ppt",
    "size": 1268382,
    "mime": "application/vnd.ms-powerpoint"
  }
}

当请求参数中没有填hash，服务器上又已经有相同内容的文件时，上传后七牛会返回579回调错误，里面包含文件的hash以及服务端返回的409错误，此时：

如果是公开资源，需要客户端自行根据base_url和hash拼接成可用的url

如果是非公开资源，已经可以直接使用请求 token 时返回的resource_uuid

2. 上传文件​

URL​

上传资源 返回值中的 upload_url

请求类型​

POST

content-type​

multipart/form-data; boundary=----WebKitFormBoundaryjQNEjXOM9W9Xq8Al

请求参数​

token 上传资源 返回值中的 token

file 文件流

返回参数列表​

参数名参数类型说明
hashstring资源 hash
urlstring资源地址
namestringname
sizeintsize
mimestringmime

3. 获取附件资源​

获取任务/消息附件资源详情，包括下载资源所需要的临时 url

URL​

https://your-host-name/project/api/project/team/:teamUUID/res/attachment/:attachmentUUID

请求类型​

GET

请求参数​

无

URL 参数​

op=imageView2/2/w/200

op 表示七牛处理参数，具体请参考七牛相关文档

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该资源的权限
404指定的资源不存在
500服务器内部错误

正确返回值参考​

{
  "name": "example.ppt",
  "hash": "FhafioiyVcbR2ORJG1lPWlTqT8Tn",
  "mime": "application/vnd.ms-powerpoint",
  "size": 1268382,
  "url": "http://7xshmn.com1.z0.glb.clouddn.com/FhafioiyVcbR2ORJG1lPWlTqT8Tn?e=1458840222&token=OxDaCSJ45X9iu9rKxVuHm6SmSP3G6D4uEah1HBaZ:aHEoPUjV7zSvZt7I83jmZkV_Irc"
}

4. 获取项目相关附件资源列表​

按照附件上传时间分页获取与某个项目相关联的附件资源列表

URL​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/attachments

请求类型​

GET

URL 参数​

since=1460543624049663&max=1460543328295374&count=100

since 表示需要获取的附件的最小上传时间，max 表示最大上传时间，两者均包含自身，即获取 create_time >= since && create_time =< max 的附件

count 表示返回附件的最大数量，最大值为 100

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该项目的权限
404指定的项目不存在
500服务器内部错误

正确返回值​

{
    "attachments": [
        ...
    ],
    "count": 2,
    "has_next": false
}

attachments 包含 Resource 列表

返回的附件资源按照 create_time 从晚到早逆序排列，如果 has_next 为 true，则表示符合条件的附件数超过了最大数量，需要用最后一个附件的 create_time 继续往前取

5. 获取任务相关附件资源列表​

按照附件上传时间分页获取与某个任务相关联的附件资源列表

URL​

https://your-host-name/project/api/project/team/:teamUUID/task/:taskUUID/attachments

请求类型​

GET

URL 参数​

since=1460543624049663&max=1460543328295374&count=100

since 表示需要获取的附件的最小上传时间，max 表示最大上传时间，两者均包含自身，即获取 create_time >= since && create_time =< max 的附件

count 表示返回附件的最大数量，最大值为 100

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该任务的权限
404指定的任务不存在
500服务器内部错误

正确返回值参考​

{
    "attachments": [
        ...
    ],
    "count": 2,
    "has_next": false
}

attachments 包含 Resource 列表

返回的附件资源按照 create_time 从晚到早逆序排列，如果 has_next 为 true，则表示符合条件的附件数超过了最大数量，需要用最后一个附件的 create_time 继续往前取

6. 获取里程碑附件资源列表​

按照附件上传时间分页获取与某个任务相关联的附件资源列表

URL​

https://your-host-name/project/api/project/team/:teamUUID/milestone/:milestoneUUID/attachments

请求类型​

GET

URL 参数​

since=1460543624049663&max=1460543328295374&count=100

since 表示需要获取的附件的最小上传时间，max 表示最大上传时间，两者均包含自身，即获取 create_time >= since && create_time =< max 的附件

count 表示返回附件的最大数量，最大值为 100

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该任务的权限
404指定的任务不存在
500服务器内部错误

正确返回值参考​

{
    "attachments": [
        ...
    ],
    "count": 2,
    "has_next": false
}

attachments 包含 Resource 列表

返回的附件资源按照 create_time 从晚到早逆序排列，如果 has_next 为 true，则表示符合条件的附件数超过了最大数量，需要用最后一个附件的 create_time 继续往前取

7. 批量删除资源​

URL​

https://your-host-name/project/api/project/team/:teamUUID/res/attachments/delete

请求类型​

POST

URL 参数​

无

JSON 参数​

["6cLx85AV", "mCrnzln5"]

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该资源的权限
500服务器内部错误

8. 修改资源名字和描述​

URL​

https://your-host-name/project/api/project/team/:teamUUID/res/attachment/update/:attachmentUUID

请求类型​

POST

请求参数列表​

参数名是否必须值类型取值范围默认值取值例子说明
namestring否len<=64IM.png文件名称
descriptionstring否len<=64文件描述

返回体参考​

{
  "name": "test_names",
  "description": "test_description"
}

返回的 HTTP status code​

状态码说明
200成功
801请求参数无效
500服务器内部错误

9. 批量获取附件资源​

URL​

https://your-host-name/project/api/project/team/:teamUUID/res/attachments

请求类型​

GET

URL 参数​

ids=VcbR2ORJ,G1lPWlTq

返回的 HTTP status code​

状态码说明
200成功
400请求参数错误
403没有访问该资源的权限
404指定的资源不存在
500服务器内部错误

正确返回值​

{
  "attachments": [
    {
      "uuid": "",
      "name": "example.ppt",
      "hash": "FhafioiyVcbR2ORJG1lPWlTqT8Tn",
      "mime": "application/vnd.ms-powerpoint",
      "size": 1268382,
      "url": "http://7xshmn.com1.z0.glb.clouddn.com/FhafioiyVcbR2ORJG1lPWlTqT8Tn?e=1458840222&token=OxDaCSJ45X9iu9rKxVuHm6SmSP3G6D4uEah1HBaZ:aHEoPUjV7zSvZt7I83jmZkV_Irc"
    }
  ],
  "count": 1,
  "errors": [
    {
      "uuid": "",
      "code": "",
      "desc": ""
    }
  ]
}
Last updated on