Rest api » History » Version 15

Eric Davis, 2010-10-21 06:23
Added a bunch of content about the different resource types in Redmine and their API status

1 1 Jean-Philippe Lang
h1. Redmine API
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
Redmine exposes some of its data through a REST API. This API provides access and basic CRUD operations (create, update, delete) for the resources described below.
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
Most of the time, the API requires authentication. This is done via HTTP Basic authentication using the regular Redmine accounts. To enable this API-style authentication, check *Enable REST API* in Administration -> Settings -> Authentication.
6 1 Jean-Philippe Lang
7 8 Ryan Lovelett
-_At the time of writing, the API is only available in trunk (see r3310, r3313)._-
8 1 Jean-Philippe Lang
9 8 Ryan Lovelett
At the time of writing, the API is available in _both_ the trunk and the stable-1.0 branch. See [[CheckingoutRedmine]]
10 8 Ryan Lovelett
11 1 Jean-Philippe Lang
h2. API Description
12 1 Jean-Philippe Lang
13 15 Eric Davis
Status legend:
14 15 Eric Davis
15 15 Eric Davis
* Stable - feature complete, no major changes planned
16 15 Eric Davis
* Beta - usable for integrations with some bugs or missing minor functionality
17 15 Eric Davis
* Alpha - major functionality in place, needs feedback from API users and integrators
18 15 Eric Davis
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
19 15 Eric Davis
* Planned - planned in a future version, depending on developer availability
20 15 Eric Davis
* Unplanned - no plans for an api in a near version.
21 15 Eric Davis
22 15 Eric Davis
23 15 Eric Davis
|*Resource*                     | *Status*    | *Notes*  |
24 15 Eric Davis
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  |
25 15 Eric Davis
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  |
26 15 Eric Davis
|[[Rest_Users|Users]]           | Planned 1.1 | |
27 15 Eric Davis
|[[Rest_WikiPages|Wiki Pages]]  | Planned 1.1 | |
28 15 Eric Davis
|[[Rest_Files|Files]]           | Planned 1.1 | |
29 15 Eric Davis
|[[Rest_News|News]]             | Prototype, Planned 1.1 | Prototype implementation for @index@ only |
30 15 Eric Davis
|[[Rest_AuthSources|Auth Sources]]           | Unplanned | |
31 15 Eric Davis
|[[Rest_Boards|Boards]]           | Unplanned | Forums. See Messages for actual threads and posts |
32 15 Eric Davis
|[[Rest_Documents|Documents]]           | Unplanned | Might be merged with Files |
33 15 Eric Davis
|[[Rest_Enumerations|Enumerations]]           | Unplanned | |
34 15 Eric Davis
|[[Rest_Groups|Groups]]           | Unplanned | |
35 15 Eric Davis
|[[Rest_IssueCategories|Issue Categories]]           | Unplanned | |
36 15 Eric Davis
|[[Rest_IssueRelations|Issue Relations]]           | Unplanned | |
37 15 Eric Davis
|[[Rest_IssueStatuses|Issue Statuses]]           | Unplanned | |
38 15 Eric Davis
|[[Rest_Journals|Journals]]           | Unplanned | Issue notes and updates (history) |
39 15 Eric Davis
|[[Rest_Members|Members]]           | Unplanned | |
40 15 Eric Davis
|[[Rest_Messages|Messages]]           | Unplanned | Forum posts|
41 15 Eric Davis
|[[Rest_Query|Query]]           | Unplanned | Custom issue queries |
42 15 Eric Davis
|[[Rest_Repositories|Repositories]]           | Unplanned | |
43 15 Eric Davis
|[[Rest_Roles|Roles]]           | Unplanned | |
44 15 Eric Davis
|[[Rest_Settings|Settings]]           | Unplanned | |
45 15 Eric Davis
|[[Rest_TimeEntries|TimeEntries]]           | Unplanned | |
46 15 Eric Davis
|[[Rest_Trackers|Trackers]]           | Unplanned | |
47 15 Eric Davis
|[[Rest_Versions|Versions]]           | Unplanned | |
48 15 Eric Davis
|[[Rest_WikiContents|WikiContents]]           | Unplanned | History of a wiki page. May be merged into the main Wiki API|
49 1 Jean-Philippe Lang
50 1 Jean-Philippe Lang
h2. API Usage
51 1 Jean-Philippe Lang
52 5 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
53 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]