forked from zapadi/redmine-net-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
1 lines (1 loc) · 2.76 KB
/
params.json
1
{"name":"Redmine-net-api","tagline":"redmine-net-api","body":"# redmine-net-api\r\n\r\nredmine-net-api is a library for communicating with a Redmine project management application\r\n\r\n* Uses [Redmine's REST API.](http://www.redmine.org/projects/redmine/wiki/Rest_api/)\r\n* Supports both XML and JSON(requires .NET Framework 3.5 or higher) formats\r\n* Supports GZipped responses from servers\r\n* This API provides access and basic CRUD operations (create, update, delete) for the resources described below\r\n * Attachments\r\n * Custom Fields\r\n * Enumerations \r\n * Groups\r\n * Issues \r\n * Issue Categories\r\n * Issue Relations\r\n * Issue Statuses\r\n * News(implementation for index only)\r\n * Projects\r\n * Project Memberships\r\n * Queries \r\n * Roles\r\n * Time Entries\r\n * Trackers\r\n * Users\r\n * Versions\r\n * Wiki Pages\r\n\r\n**Authentication**\r\n\r\nMost of the time, the API requires authentication. To enable the API-style authentication, you have to check Enable REST API in Administration -> Settings -> Authentication. Then, authentication can be done in 2 different ways:\r\nusing your regular login/password via HTTP Basic authentication.\r\nusing your API key which is a handy way to avoid putting a password in a script. The API key may be attached to each request in one of the following way:\r\n * passed in as a \"key\" parameter\r\n * passed in as a username with a random password via HTTP Basic authentication\r\n * passed in as a \"X-Redmine-API-Key\" HTTP header (added in Redmine 1.1.0)\r\nYou can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.\r\n\r\n**User Impersonation**\r\n\r\nAs of Redmine 2.2.0, you can impersonate user through the REST API by setting the X-Redmine-Switch-User header of your API request. It must be set to a user login (eg. X-Redmine-Switch-User: jsmith). This only works when using the API with an administrator account, this header will be ignored when using the API with a regular user account.\r\n\r\nIf the login specified with the X-Redmine-Switch-User header does not exist or is not active, you will receive a 412 error response.\r\n\r\n\r\n<br />\r\n## Help me help you ##\r\nYour feedback is crucial. If you find anything that could improve the API, let me know. I will gladly receive your input and make the proper adjustments.\r\n\r\n**If you find this API useful let others know about it and/or rate it.**<br />\r\nYour contribution is always welcome.\r\n\r\n<br />\r\n## Licence ##\r\nThe API is released under Apache 2 open-source license. You can use it for both personal and commercial purposes, build upon it and modify it.\r\n\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}