Requests

Supported Formats

json
>>>

GET /api/v1/:team/:note/requests
List note requests

Supported Formats

json

Examples

GET /api/v1/test/test_note/requests
200
[

]
GET /api/v1/test/test_note/requests
200
[
  {
    "id": 4,
    "is_closed": false,
    "is_merged": false,
    "index": 2,
    "created_at": "2016-01-07T02:03:58.000Z",
    "updated_at": "2016-01-07T02:03:58.000Z",
    "is_wip": false,
    "html_url": "http://www.example.com/test/test_note/requests/2",
    "label": "request #2",
    "to_note": {
      "id": 129,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:03:49.000Z",
      "updated_at": "2016-01-07T02:03:58.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 113,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:03:44.000Z",
        "updated_at": "2016-01-07T02:03:58.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:03:44.000Z",
            "updated_at": "2016-01-07T02:03:53.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"
    },
    "from_note": {
      "id": 134,
      "user_id": 3,
      "is_private": false,
      "pulled_at": "2016-01-07T02:03:55.000Z",
      "title": "Copy of Test note (test)",
      "created_at": "2016-01-07T02:03:56.000Z",
      "updated_at": "2016-01-07T02:03:58.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "forked": {
        "id": 129,
        "is_private": false,
        "slug": "test_note",
        "title": "Test note",
        "created_at": "2016-01-07T02:03:49.000Z",
        "updated_at": "2016-01-07T02:03:58.000Z",
        "format": "html",
        "share": "none",
        "is_time_track": true,
        "name": "test_note",
        "team": {
          "id": 113,
          "name": "test",
          "is_default": true,
          "created_at": "2016-01-07T02:03:44.000Z",
          "updated_at": "2016-01-07T02:03:58.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:03:44.000Z",
              "updated_at": "2016-01-07T02:03:53.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"
      },
      "name": "134",
      "team": {
        "id": 113,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:03:44.000Z",
        "updated_at": "2016-01-07T02:03:58.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:03:44.000Z",
            "updated_at": "2016-01-07T02:03:53.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/134",
      "avatar_url": "http://www.example.com/test/134/avatar",
      "can_pull": false,
      "can_request": false,
      "can_manage": true,
      "description_html": "<p></p>",
      "model": "note"
    },
    "user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:03:44.000Z",
      "updated_at": "2016-01-07T02:03:53.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"
    },
    "pages": [
      {
        "id": 249,
        "created_at": "2016-01-07T02:03:57.000Z",
        "note_id": 134,
        "type": "create",
        "path": "test / Copy of Test note (test) / Request page",
        "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
        "merged": false
      }
    ],
    "attachments": [],
    "active": true,
    "can_open": true,
    "status": "opened",
    "model": "request"
  }
]

Params

Param name Description
state
optional

Can be either open, merged, closed or all. Default: open


Value:

Must be String
>>>

GET /api/v1/:team/:note/requests/:index
Get a single request

Supported Formats

json

Examples

GET /api/v1/test/test_note/requests/2
200
{
  "id": 12,
  "is_closed": false,
  "is_merged": false,
  "index": 2,
  "created_at": "2016-01-07T02:04:51.000Z",
  "updated_at": "2016-01-07T02:04:51.000Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 177,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:04:43.000Z",
    "updated_at": "2016-01-07T02:04:51.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 153,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:38.000Z",
      "updated_at": "2016-01-07T02:04:51.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:04:38.000Z",
          "updated_at": "2016-01-07T02:04:47.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"
  },
  "from_note": {
    "id": 182,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:04:48.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:04:50.000Z",
    "updated_at": "2016-01-07T02:04:51.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 177,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:04:43.000Z",
      "updated_at": "2016-01-07T02:04:51.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 153,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:04:38.000Z",
        "updated_at": "2016-01-07T02:04:51.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:04:38.000Z",
            "updated_at": "2016-01-07T02:04:47.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"
    },
    "name": "182",
    "team": {
      "id": 153,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:38.000Z",
      "updated_at": "2016-01-07T02:04:51.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:04:38.000Z",
          "updated_at": "2016-01-07T02:04:47.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/182",
    "avatar_url": "http://www.example.com/test/182/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:04:38.000Z",
    "updated_at": "2016-01-07T02:04:47.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"
  },
  "pages": [
    {
      "id": 341,
      "created_at": "2016-01-07T02:04:51.000Z",
      "note_id": 182,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": true,
  "can_open": true,
  "status": "opened",
  "model": "request"
}
>>>

POST /api/v1/:team/:note/requests
Create

Supported Formats

json

Examples

POST /api/v1/test/158/requests
&page_versions%5B%5D=295
200
{
  "id": 8,
  "is_closed": false,
  "is_merged": false,
  "index": 2,
  "created_at": "2016-01-07T02:04:25.434Z",
  "updated_at": "2016-01-07T02:04:25.434Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 153,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:04:16.000Z",
    "updated_at": "2016-01-07T02:04:25.487Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 133,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:11.000Z",
      "updated_at": "2016-01-07T02:04:25.493Z",
      "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:04:11.000Z",
          "updated_at": "2016-01-07T02:04:20.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"
  },
  "from_note": {
    "id": 158,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:04:21.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:04:22.000Z",
    "updated_at": "2016-01-07T02:04:25.442Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 153,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:04:16.000Z",
      "updated_at": "2016-01-07T02:04:25.479Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 133,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:04:11.000Z",
        "updated_at": "2016-01-07T02:04:25.485Z",
        "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:04:11.000Z",
            "updated_at": "2016-01-07T02:04:20.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"
    },
    "name": "158",
    "team": {
      "id": 133,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:11.000Z",
      "updated_at": "2016-01-07T02:04:25.477Z",
      "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:04:11.000Z",
          "updated_at": "2016-01-07T02:04:20.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/158",
    "avatar_url": "http://www.example.com/test/158/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:04:11.000Z",
    "updated_at": "2016-01-07T02:04:20.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"
  },
  "pages": [
    {
      "id": 295,
      "created_at": "2016-01-07T02:04:24.000Z",
      "note_id": 158,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": true,
  "can_open": true,
  "status": "opened",
  "model": "request"
}
>>>

PATCH /api/v1/:team/:note/requests/:index/merge
Merge

Supported Formats

json

Examples

PUT /api/v1/test/test_note/requests/2/merge

200
{
  "id": 6,
  "is_closed": false,
  "is_merged": true,
  "index": 2,
  "created_at": "2016-01-07T02:04:11.000Z",
  "updated_at": "2016-01-07T02:04:11.669Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 141,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:04:03.000Z",
    "updated_at": "2016-01-07T02:04:11.690Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 123,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:03:59.000Z",
      "updated_at": "2016-01-07T02:04:11.698Z",
      "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:03:59.000Z",
          "updated_at": "2016-01-07T02:04:07.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"
  },
  "from_note": {
    "id": 146,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:04:08.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:04:09.000Z",
    "updated_at": "2016-01-07T02:04:11.670Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 141,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:04:03.000Z",
      "updated_at": "2016-01-07T02:04:11.680Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 123,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:03:59.000Z",
        "updated_at": "2016-01-07T02:04:11.688Z",
        "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:03:59.000Z",
            "updated_at": "2016-01-07T02:04:07.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"
    },
    "name": "146",
    "team": {
      "id": 123,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:03:59.000Z",
      "updated_at": "2016-01-07T02:04:11.677Z",
      "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:03:59.000Z",
          "updated_at": "2016-01-07T02:04:07.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/146",
    "avatar_url": "http://www.example.com/test/146/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:03:59.000Z",
    "updated_at": "2016-01-07T02:04:07.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"
  },
  "pages": [
    {
      "id": 272,
      "created_at": "2016-01-07T02:04:10.000Z",
      "note_id": 146,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": false,
  "can_open": true,
  "status": "merged",
  "model": "request"
}
>>>

PATCH /api/v1/:team/:note/requests/:index/close
Close

Supported Formats

json

Examples

PUT /api/v1/test/test_note/requests/2/close

200
{
  "id": 2,
  "is_closed": true,
  "is_merged": false,
  "index": 2,
  "created_at": "2016-01-07T02:03:42.000Z",
  "updated_at": "2016-01-07T02:03:43.311Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 117,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:03:33.000Z",
    "updated_at": "2016-01-07T02:03:43.331Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 103,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:03:28.000Z",
      "updated_at": "2016-01-07T02:03:43.339Z",
      "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:03:28.000Z",
          "updated_at": "2016-01-07T02:03:38.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"
  },
  "from_note": {
    "id": 122,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:03:39.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:03:40.000Z",
    "updated_at": "2016-01-07T02:03:43.313Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 117,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:03:33.000Z",
      "updated_at": "2016-01-07T02:03:43.323Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 103,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:03:28.000Z",
        "updated_at": "2016-01-07T02:03:43.330Z",
        "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:03:28.000Z",
            "updated_at": "2016-01-07T02:03:38.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"
    },
    "name": "122",
    "team": {
      "id": 103,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:03:28.000Z",
      "updated_at": "2016-01-07T02:03:43.320Z",
      "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:03:28.000Z",
          "updated_at": "2016-01-07T02:03:38.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/122",
    "avatar_url": "http://www.example.com/test/122/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:03:28.000Z",
    "updated_at": "2016-01-07T02:03:38.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"
  },
  "pages": [
    {
      "id": 226,
      "created_at": "2016-01-07T02:03:42.000Z",
      "note_id": 122,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": false,
  "can_open": true,
  "status": "closed",
  "model": "request"
}
PUT /api/v1/test/test_note/requests/2/close

200
{
  "id": 10,
  "is_closed": true,
  "is_merged": false,
  "index": 2,
  "created_at": "2016-01-07T02:04:37.000Z",
  "updated_at": "2016-01-07T02:04:38.177Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 165,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:04:30.000Z",
    "updated_at": "2016-01-07T02:04:38.193Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 143,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:25.000Z",
      "updated_at": "2016-01-07T02:04:38.199Z",
      "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:04:25.000Z",
          "updated_at": "2016-01-07T02:04:34.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"
  },
  "from_note": {
    "id": 170,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:04:35.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:04:36.000Z",
    "updated_at": "2016-01-07T02:04:38.178Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 165,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:04:30.000Z",
      "updated_at": "2016-01-07T02:04:38.186Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 143,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:04:25.000Z",
        "updated_at": "2016-01-07T02:04:38.192Z",
        "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:04:25.000Z",
            "updated_at": "2016-01-07T02:04:34.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"
    },
    "name": "170",
    "team": {
      "id": 143,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:25.000Z",
      "updated_at": "2016-01-07T02:04:38.183Z",
      "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:04:25.000Z",
          "updated_at": "2016-01-07T02:04:34.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/170",
    "avatar_url": "http://www.example.com/test/170/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:04:25.000Z",
    "updated_at": "2016-01-07T02:04:34.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"
  },
  "pages": [
    {
      "id": 318,
      "created_at": "2016-01-07T02:04:37.000Z",
      "note_id": 170,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": false,
  "can_open": true,
  "status": "closed",
  "model": "request"
}
>>>

PATCH /api/v1/:team/:note/requests/:index/open
Open

Supported Formats

json

Examples

PUT /api/v1/test/test_note/requests/2/open

200
{
  "id": 10,
  "is_closed": false,
  "is_merged": false,
  "index": 2,
  "created_at": "2016-01-07T02:04:37.000Z",
  "updated_at": "2016-01-07T02:04:38.534Z",
  "is_wip": false,
  "html_url": "http://www.example.com/test/test_note/requests/2",
  "label": "request #2",
  "to_note": {
    "id": 165,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:04:30.000Z",
    "updated_at": "2016-01-07T02:04:38.551Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 143,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:25.000Z",
      "updated_at": "2016-01-07T02:04:38.557Z",
      "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:04:25.000Z",
          "updated_at": "2016-01-07T02:04:34.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"
  },
  "from_note": {
    "id": 170,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:04:35.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:04:36.000Z",
    "updated_at": "2016-01-07T02:04:38.536Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 165,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:04:30.000Z",
      "updated_at": "2016-01-07T02:04:38.544Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 143,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:04:25.000Z",
        "updated_at": "2016-01-07T02:04:38.550Z",
        "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:04:25.000Z",
            "updated_at": "2016-01-07T02:04:34.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"
    },
    "name": "170",
    "team": {
      "id": 143,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:04:25.000Z",
      "updated_at": "2016-01-07T02:04:38.542Z",
      "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:04:25.000Z",
          "updated_at": "2016-01-07T02:04:34.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/170",
    "avatar_url": "http://www.example.com/test/170/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:04:25.000Z",
    "updated_at": "2016-01-07T02:04:34.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"
  },
  "pages": [
    {
      "id": 318,
      "created_at": "2016-01-07T02:04:37.000Z",
      "note_id": 170,
      "type": "create",
      "path": "test / Copy of Test note (test) / Request page",
      "diff": "<div class=\"diff\">\n  <ul>\n    <li class=\"ins\" data-labels=\"12693752438\"><ins><span class=\"symbol\">+</span>Request content</ins></li>\n  </ul>\n</div>\n",
      "merged": false
    }
  ],
  "attachments": [],
  "active": true,
  "can_open": true,
  "status": "opened",
  "model": "request"
}
>>>

DELETE /api/v1/:team/:note/requests/:index
Destroy

Supported Formats

json
>>>

GET /api/v1/:team/:note/requests/:index/comments
List comments

Supported Formats

json
>>>

POST /api/v1/:team/:note/requests/:index/comments
Create comment

Supported Formats

json

Params

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/:team/:note/requests/:index/comments/:id
Destroy comment

Supported Formats

json