目录

• model
  • resource
  • type
• 1. 上传资源
• 2. 上传文件
• 3. 获取附件资源
• 4. 获取项目相关附件资源列表
• 5. 获取任务相关附件资源列表
• 6. 获取里程碑附件资源列表
• 7. 批量删除资源
• 8. 修改资源名字和描述
• 9. 批量获取附件资源

通用说明

API说明

model

resource

资源模型

type

资源类型

reftype

当 type=attachment 时，ref_type

1. 上传资源

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

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

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

URL

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

请求类型

POST

请求参数

resource

返回参数列表

file

请求参数参考

{
    "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 文件流

返回参数列表

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

正确返回值参考

{
    "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

正确返回值

{
    "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

正确返回值参考

{
    "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

正确返回值参考

{
    "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

8. 修改资源名字和描述

URL

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

请求类型

POST

请求参数列表

返回体参考

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

返回的HTTP status code

9. 批量获取附件资源

URL

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

请求类型

GET

URL参数

ids=VcbR2ORJ,G1lPWlTq

返回的HTTP status code

正确返回值

{
    "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": ""
        }
    ]
}