GET /api/v1/test/test_note/issues 200 [ ]
GET /api/v1/test/test_note/issues 200 [ { "id": 10, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:11:09.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:00.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:00.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 579, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:11:04.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 513, "name": "test", "is_default": true, "created_at": "2016-01-07T02:11:00.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:00.000Z", "updated_at": "2016-01-07T02:11:09.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" } ]
Param name | Description |
---|---|
state optional |
Can be either Value: Must be String |
GET /api/v1/test/test_note/issues/1 200 { "id": 5, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:10:22.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:12.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:12.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 524, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:10:17.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 463, "name": "test", "is_default": true, "created_at": "2016-01-07T02:10:12.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:12.000Z", "updated_at": "2016-01-07T02:10:22.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" }
POST /api/v1/test/test_note/issues issue%5Btitle%5D=Test+issue&issue%5Bto_user%5D=test 200 { "id": 7, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:10:40.331Z", "updated_at": "2016-01-07T02:10:40.331Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:31.000Z", "updated_at": "2016-01-07T02:10:40.396Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:31.000Z", "updated_at": "2016-01-07T02:10:39.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 546, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:10:35.000Z", "updated_at": "2016-01-07T02:10:40.397Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 483, "name": "test", "is_default": true, "created_at": "2016-01-07T02:10:31.000Z", "updated_at": "2016-01-07T02:10:40.398Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:31.000Z", "updated_at": "2016-01-07T02:10:40.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" }
Param name | Description |
---|---|
issue optional |
Value: Must be a Hash |
issue[title] required |
Value: Must be String |
issue[description] optional |
Value: Must be String |
issue[to_user] optional |
Username Value: Must be String |
PUT /api/v1/test/test_note/issues/1 issue%5Btitle%5D=Edited+issue&issue%5Bto_user%5D=test 200 { "id": 11, "title": "Edited issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:11:17.000Z", "updated_at": "2016-01-07T02:11:18.078Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:09.000Z", "updated_at": "2016-01-07T02:11:18.084Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:09.000Z", "updated_at": "2016-01-07T02:11:18.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 590, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:11:13.000Z", "updated_at": "2016-01-07T02:11:18.085Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 523, "name": "test", "is_default": true, "created_at": "2016-01-07T02:11:09.000Z", "updated_at": "2016-01-07T02:11:18.090Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:09.000Z", "updated_at": "2016-01-07T02:11:18.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Edited issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" }
Param name | Description |
---|---|
issue optional |
Value: Must be a Hash |
issue[title] required |
Value: Must be String |
issue[description] optional |
Value: Must be String |
issue[to_user] optional |
Username Value: Must be String |
DELETE /api/v1/test/test_note/issues/1 204
GET /api/v1/test/test_note/issues/1/comments 200 [ { "id": 8, "comment": "Test comment", "user_id": 3, "created_at": "2016-01-07T02:10:59.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "mentions": [ { "id": 1, "username": "test1", "receive_email": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "keyboard_shortcuts": false, "html_url": "http://www.example.com/test1", "avatar_url": "http://www.example.com/test1/avatar", "lang": { "code": "ja", "model": "lang" }, "name": "test1", "model": "user" } ], "can_delete": true, "type": "issue", "issue": { "id": 9, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:10:59.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 568, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:10:54.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 503, "name": "test", "is_default": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:49.000Z", "updated_at": "2016-01-07T02:10:59.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" }, "model": "comment" } ]
POST /api/v1/test/test_note/issues/1/comments comment%5Bcomment%5D=Test+comment&mentions%5B%5D=test1 200 { "id": 9, "comment": "Test comment", "user_id": 3, "created_at": "2016-01-07T02:11:27.429Z", "updated_at": "2016-01-07T02:11:27.429Z", "user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "mentions": [ { "id": 1, "username": "test1", "receive_email": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.000Z", "keyboard_shortcuts": false, "html_url": "http://www.example.com/test1", "avatar_url": "http://www.example.com/test1/avatar", "lang": { "code": "ja", "model": "lang" }, "name": "test1", "model": "user" } ], "can_delete": true, "type": "issue", "issue": { "id": 12, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:11:27.000Z", "updated_at": "2016-01-07T02:11:27.443Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.444Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 601, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:11:23.000Z", "updated_at": "2016-01-07T02:11:27.445Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 533, "name": "test", "is_default": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.446Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:11:18.000Z", "updated_at": "2016-01-07T02:11:27.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [], "description_html": "<p></p>", "model": "issue" }, "model": "comment" }
Param name | Description |
---|---|
comment optional |
Value: Must be a Hash |
comment[comment] required |
Value: Must be String |
mentions optional |
Usernames Value: Must be an array of String |
DELETE /api/v1/test/test_note/issues/1/comments/7 204
POST /api/v1/test/test_note/issues/1/tags tags%5B%5D=tag1&tags%5B%5D=tag2 200 { "id": 4, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:10:11.000Z", "updated_at": "2016-01-07T02:10:11.000Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:01.000Z", "updated_at": "2016-01-07T02:10:12.048Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:01.000Z", "updated_at": "2016-01-07T02:10:11.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 513, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:10:07.000Z", "updated_at": "2016-01-07T02:10:12.049Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 453, "name": "test", "is_default": true, "created_at": "2016-01-07T02:10:01.000Z", "updated_at": "2016-01-07T02:10:12.055Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:01.000Z", "updated_at": "2016-01-07T02:10:12.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [ { "html_url": "http://www.example.com/test/test_note/issues?tag=tag1", "name": "tag1" }, { "html_url": "http://www.example.com/test/test_note/issues?tag=tag2", "name": "tag2" } ], "description_html": "<p></p>", "model": "issue" }
Param name | Description |
---|---|
tags optional |
Value: Must be an array of String |
DELETE /api/v1/test/test_note/issues/1/tags/tag1 200 { "id": 6, "title": "Test issue", "is_done": false, "index": 1, "created_at": "2016-01-07T02:10:31.000Z", "updated_at": "2016-01-07T02:10:31.000Z", "position": 1, "rate": 0, "to_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:22.000Z", "updated_at": "2016-01-07T02:10:31.195Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "from_user": { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:22.000Z", "updated_at": "2016-01-07T02:10:31.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" }, "note": { "id": 535, "is_private": false, "slug": "test_note", "title": "Test note", "created_at": "2016-01-07T02:10:26.000Z", "updated_at": "2016-01-07T02:10:31.196Z", "format": "html", "share": "none", "is_time_track": true, "name": "test_note", "team": { "id": 473, "name": "test", "is_default": true, "created_at": "2016-01-07T02:10:22.000Z", "updated_at": "2016-01-07T02:10:31.202Z", "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "role": "manager", "managers": [ { "id": 3, "username": "test", "receive_email": true, "created_at": "2016-01-07T02:10:22.000Z", "updated_at": "2016-01-07T02:10:31.000Z", "keyboard_shortcuts": false, "options": { "advanced_menu": true }, "html_url": "http://www.example.com/test", "avatar_url": "http://www.example.com/test/avatar", "lang": { "code": "en", "model": "lang" }, "name": "test", "model": "user" } ], "members": [], "plan": "micro", "model": "team" }, "html_url": "http://www.example.com/test/test_note", "avatar_url": "http://www.example.com/test/test_note/avatar", "can_pull": false, "can_request": false, "can_manage": true, "description_html": "<p></p>", "model": "note" }, "label": "Issue #1 Test issue", "html_url": "http://www.example.com/test/test_note/issues/1", "can_manage": true, "tags": [ { "html_url": "http://www.example.com/test/test_note/issues?tag=tag2", "name": "tag2" } ], "description_html": "<p></p>", "model": "issue" }