Redmine is a web based tool for software project management.
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
List issues |
|
Create an issue |
|
Get issue by ID |
|
Update an issue |
|
List projects |
|
Create a project |
|
Get project by ID |
|
List users |
|
Get user by ID |
|
Get current user |
|
List priorities |
Name |
Summary |
When a project is created |
|
When an issue is created |
|
When an issue is updated |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List issues
Description: List issues.
Syntax:
Redmine.ListIssues ()
Returns:
Type:ListIssuesResponse
Summary: Create an issue
Description: Create an issue.
Syntax:
Redmine.CreateIssue (CreateIssueRequest issue)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
issue |
|
|
True |
Returns:
Type:CreateIssueResponse
Summary: Get issue by ID
Description: Get issue by ID.
Syntax:
Redmine.GetIssue (string issue_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
issue_id |
string (Issue) |
Issue. |
True |
Returns:
Type:GetIssueResponse
Summary: Update an issue
Description: Update an issue.
Syntax:
Redmine.UpdateIssue (string issue_id, UpdateIssueRequest issue)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
issue_id |
string (Issue) |
Issue. |
True |
|
issue |
|
|
True |
Returns:
Type:string
Summary: List projects
Description: List projects.
Syntax:
Redmine.ListProjects ()
Returns:
Type:ListProjectsResponse
Summary: Create a project
Description: Create a project.
Syntax:
Redmine.CreateProject (CreateProjectRequest project)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
project |
|
|
True |
Returns:
Summary: Get project by ID
Description: Get project by ID.
Syntax:
Redmine.GetProject (string project_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
project_id |
string (Project) |
Project. |
True |
Returns:
Type:GetProjectResponse
Summary: List users
Description: List users.
Syntax:
Redmine.ListUsers ()
Returns:
Type:ListUsersResponse
Summary: Get user by ID
Description: Get user by ID.
Syntax:
Redmine.GetUser (string user_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
user_id |
string (User) |
User. |
True |
Returns:
Type:GetUserResponse
Summary: Get current user
Description: Get current user.
Syntax:
Redmine.GetCurrentUser ()
Returns:
Type:GetUserResponse
Summary: List priorities
Description: List priorities.
Syntax:
Redmine.ListPriorities ()
Returns:
Summary: When a project is created
Description: When a project is created.
Syntax:
Redmine.OnNewProject ()
Returns:
Type:ListProjectsResponse
Summary: When an issue is created
Description: When an issue is created.
Syntax:
Redmine.OnNewIssue (string project_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
project_id |
string (Project) |
Project. |
True |
Returns:
Type:ListIssuesResponse
Summary: When an issue is updated
Description: When an issue is updated.
Syntax:
Redmine.OnUpdatedIssue (string project_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
project_id |
string (Project) |
Project. |
True |
Returns:
Type:ListIssuesResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
issue |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
project_id |
string Project |
Project. |
priority_id |
string Priority |
Priority. |
tracker_id |
string Tracker |
Tracker. Values: [Bug, Feature, Support] |
subject |
string Subject |
Subject. |
description |
string Description |
Description. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Issue Id |
Issue Id. |
project |
|
|
tracker |
|
|
status |
|
|
priority |
|
|
author |
|
|
subject |
string Subject |
Subject. |
description |
string Description |
Description. |
start_date |
string Start date |
Start date. |
due_date |
string Due date |
Due date. |
done_ratio |
integer(int32) Done ratio |
Done ratio. |
estimated_hours |
number(float) Estimated hours |
Estimated hours. |
total_estimated_hours |
number(float) Total estimated hours |
Total estimated hours. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project Id |
Project Id. |
name |
string Project name |
Project name. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Tracker Id |
Tracker Id. |
name |
string Tracker |
Tracker. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Status Id |
Status Id. |
name |
string Status |
Status. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Priority Id |
Priority Id. |
name |
string Priority |
Priority. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Author Id |
Author Id. |
name |
string Author |
Author. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
project |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Name of project. |
identifier |
string Identifier |
Unique friendly name that is different from id. |
description |
string Description |
Description. |
homepage |
string Homepage |
Homepage. |
parent_id |
string Parent project |
Select the parent project. |
is_public |
boolean Public |
Is a public project. |
inherit_members |
boolean Inherit members |
Inherit members. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project id |
Project id. |
name |
string Project name |
Project name. |
identifier |
string Identifier |
Unique friendly name that is different from id. |
description |
string Description |
Description. |
homepage |
string Homepage |
Homepage. |
parent |
|
|
status |
integer(int32) Status |
Status. |
is_public |
boolean Public |
Public. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Parent Id |
Parent Id. |
name |
string Parent |
Parent. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Issue Id |
Issue Id. |
project |
|
|
tracker |
|
|
status |
|
|
priority |
|
|
author |
|
|
subject |
string Subject |
Subject. |
description |
string Description |
Description. |
start_date |
string Start date |
Start date. |
due_date |
string Due date |
Due date. |
done_ratio |
integer(int32) Done ratio |
Done ratio. |
estimated_hours |
number(float) Estimated hours |
Estimated hours. |
total_estimated_hours |
number(float) Total estimated hours |
Total estimated hours. |
spent_hours |
number(float) Spent hours |
Spent hours. |
total_spent_hours |
number(float) Total spent hours |
Total spent hours. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project Id |
Project Id. |
name |
string Project name |
Project name. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Tracker Id |
Tracker Id. |
name |
string Tracker |
Tracker. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Status Id |
Status Id. |
name |
string Status |
Status. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Priority Id |
Priority Id. |
name |
string Priority |
Priority. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Author Id |
Author Id. |
name |
string Author |
Author. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project id |
Project id. |
name |
string Project name |
Project name. |
identifier |
string Identifier |
Unique friendly name that is different from id. |
description |
string Description |
Description. |
homepage |
string Homepage |
Homepage. |
status |
integer(int32) Status |
Status. |
is_public |
boolean Public |
Public. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) User Id |
User Id. |
login |
string Login |
Login. |
firstname |
string First name |
First name. |
lastname |
string Last name |
Last name. |
|
string |
Email. |
created_on |
string(date-time) Created on |
Created on. |
last_login_on |
string(date-time) Last login |
Last login. |
api_key |
string API key |
API key. |
status |
integer(int32) Status |
Status. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Issue Id |
Issue Id. |
project |
|
|
tracker |
|
|
status |
|
|
priority |
|
|
author |
|
|
subject |
string Subject |
Subject. |
description |
string Description |
Description. |
start_date |
string Start date |
Start date. |
due_date |
string Due date |
Due date. |
done_ratio |
number(float) Done ratio |
Done ratio. |
estimated_hours |
number(float) Estimated hours |
Estimated hours. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project Id |
Project Id. |
name |
string Project name |
Project name. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Tracker Id |
Tracker Id. |
name |
string Tracker |
Tracker. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Status Id |
Status Id. |
name |
string Status |
Status. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Priority Id |
Priority Id. |
name |
string Priority |
Priority. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Author Id |
Author Id. |
name |
string Author |
Author. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
issues |
array of (IssueResponse) Issues |
Issues. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
issue_priorities |
array of (ProjectResponse) Projects |
Priorities. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
projects |
array of (ProjectResponse) Projects |
Projects. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
users |
array of (UserResponse) Users |
Users. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Project id |
Project id. |
name |
string Project name |
Project name. |
identifier |
string Identifier |
Unique friendly name that is different from id. |
description |
string Description |
Description. |
status |
integer(int32) Status |
Status. |
is_public |
boolean Public |
Public. |
created_on |
string(date-time) Created on |
Created on. |
updated_on |
string(date-time) Updated on |
Updated on. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
issue |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
priority_id |
string Priority |
Priority. |
tracker_id |
string Tracker |
Tracker. Values: [Bug, Feature, Support] |
status_id |
string Status |
Status. Values: [New, In Progress, Resolved, Feedback, Closed, Rejected] |
subject |
string Subject |
Subject. |
description |
string Description |
Description. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) User Id |
User Id. |
login |
string Login |
Login. |
firstname |
string First name |
First name. |
lastname |
string Last name |
Last name. |
|
string |
Email. |
created_on |
string(date-time) Created on |
Created on. |
last_login_on |
string(date-time) Last login |
Last login. |