You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+101-1Lines changed: 101 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -217,7 +217,9 @@ try {
217
217
218
218
## API
219
219
220
-
You can now use the `getApi()` method to create and get a specific Redmine API.
220
+
### Mid-level API
221
+
222
+
You can now use the `getApi()` method to create and get a specific Redmine API. This simplifies common use-cases and gives you some features like caching and assigning a user to an issue by username instead of the user ID.
221
223
222
224
To check for failed requests you can afterwards check the status code via `$client->getLastResponseStatusCode()`.
*:x:*Issue Relations - only partially implemented*
568
+
*:heavy_check_mark: Issue Statuses
569
+
*:heavy_check_mark: News
570
+
*:heavy_check_mark: Projects
571
+
*:heavy_check_mark: Project Memberships
572
+
*:heavy_check_mark: Queries
573
+
*:heavy_check_mark: Roles
574
+
*:heavy_check_mark: Time Entries
575
+
*:heavy_check_mark: Time Entry Activities
576
+
*:heavy_check_mark: Trackers
577
+
*:heavy_check_mark: Users
578
+
*:heavy_check_mark: Versions
579
+
*:heavy_check_mark: Wiki
580
+
581
+
If some features are missing in `getApi()` you are welcome to create a PR. Besides, it is always possible to use the low-level API.
582
+
583
+
### Low-level API
584
+
585
+
The low-level API allows you to send highly customized requests to the Redmine server.
586
+
587
+
> :bulb: See the [Redmine REST-API docs](https://www.redmine.org/projects/redmine/wiki/Rest_api) for available endpoints and required parameters.
588
+
589
+
The client has 4 methods for requests:
590
+
591
+
-`requestGet()`
592
+
-`requestPost()`
593
+
-`requestPut()`
594
+
-`requestDelete()`
595
+
596
+
Using this methods you can use every Redmine API endpoint. The following example shows you how to rename a project and add a custom field. To build the XML body you can use the `XmlSerializer`.
0 commit comments