Connectors Reference

Redmine

Redmine is a web based tool for software project management.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListIssues ()

List issues

CreateIssue (CreateIssueRequest issue)

Create an issue

GetIssue (string issue_id)

Get issue by ID

UpdateIssue (string issue_id, UpdateIssueRequest issue)

Update an issue

ListProjects ()

List projects

CreateProject (CreateProjectRequest project)

Create a project

GetProject (string project_id)

Get project by ID

ListUsers ()

List users

GetUser (string user_id)

Get user by ID

GetCurrentUser ()

Get current user

ListPriorities ()

List priorities

 

Triggers:

Name

Summary

OnNewProject ()

When a project is created

OnNewIssue (string project_id)

When an issue is created

OnUpdatedIssue (string project_id)

When an issue is updated

 

Objects:

Name

Summary

CreateIssueRequest

 

CreateIssueResponse

 

CreateProjectRequest

 

CreateProjectResponse

 

GetIssueResponse

 

GetProjectResponse

 

GetUserResponse

 

IssueResponse

 

ListIssuesResponse

 

ListPrioritiesResponse

 

ListProjectsResponse

 

ListUsersResponse

 

ProjectResponse

 

UpdateIssueRequest

 

UserResponse

 

 

Actions:

ListIssues

Summary: List issues

Description: List issues.

 

Syntax:

Redmine.ListIssues ()

 

Returns:

          Type:ListIssuesResponse

 

CreateIssue

Summary: Create an issue

Description: Create an issue.

 

Syntax:

Redmine.CreateIssue (CreateIssueRequest issue)

 

Parameters:

Name

Type

Summary

Required

Related Action

issue

CreateIssueRequest

 

 

True

 

Returns:

          Type:CreateIssueResponse

 

GetIssue

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

 

UpdateIssue

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

ListIssues

issue

UpdateIssueRequest

 

 

True

 

Returns:

          Type:string

 

ListProjects

Summary: List projects

Description: List projects.

 

Syntax:

Redmine.ListProjects ()

 

Returns:

          Type:ListProjectsResponse

 

CreateProject

Summary: Create a project

Description: Create a project.

 

Syntax:

Redmine.CreateProject (CreateProjectRequest project)

 

Parameters:

Name

Type

Summary

Required

Related Action

project

CreateProjectRequest

 

 

True

 

Returns:

          Type:CreateProjectResponse

 

GetProject

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

 

ListUsers

Summary: List users

Description: List users.

 

Syntax:

Redmine.ListUsers ()

 

Returns:

          Type:ListUsersResponse

 

GetUser

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

 

GetCurrentUser

Summary: Get current user

Description: Get current user.

 

Syntax:

Redmine.GetCurrentUser ()

 

Returns:

          Type:GetUserResponse

 

ListPriorities

Summary: List priorities

Description: List priorities.

 

Syntax:

Redmine.ListPriorities ()

 

Returns:

          Type:ListPrioritiesResponse

 

Triggers:

Trigger OnNewProject

Summary: When a project is created

Description: When a project is created.

 

Syntax:

Redmine.OnNewProject ()

 

Returns:

          Type:ListProjectsResponse

 

Trigger OnNewIssue

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

ListProjects

 

Returns:

          Type:ListIssuesResponse

 

Trigger OnUpdatedIssue

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

ListProjects

 

Returns:

          Type:ListIssuesResponse

 


 

CreateIssueRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

issue

Issue

 

 

 

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.

 


 

CreateIssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Issue Id

Issue Id.

project

Project

 

 

tracker

Tracker

 

 

status

Status

 

 

priority

Priority

 

 

author

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.

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

Project Id.

name

string

Project name

Project name.

 

Tracker

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Tracker Id

Tracker Id.

name

string

Tracker

Tracker.

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Id

Status Id.

name

string

Status

Status.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

Priority Id.

name

string

Priority

Priority.

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

Author Id.

name

string

Author

Author.

 


 

CreateProjectRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

Project

 

 

 

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.

 


 

CreateProjectResponse

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

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.

 

Parent

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Parent Id

Parent Id.

name

string

Parent

Parent.

 


 

GetIssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Issue Id

Issue Id.

project

Project

 

 

tracker

Tracker

 

 

status

Status

 

 

priority

Priority

 

 

author

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.

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

Project Id.

name

string

Project name

Project name.

 

Tracker

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Tracker Id

Tracker Id.

name

string

Tracker

Tracker.

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Id

Status Id.

name

string

Status

Status.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

Priority Id.

name

string

Priority

Priority.

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

Author Id.

name

string

Author

Author.

 


 

GetProjectResponse

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.


 

GetUserResponse

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.

mail

string

Email

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.


 

IssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Issue Id

Issue Id.

project

Project

 

 

tracker

Tracker

 

 

status

Status

 

 

priority

Priority

 

 

author

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.

created_on

string(date-time)

Created on

Created on.

updated_on

string(date-time)

Updated on

Updated on.

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

Project Id.

name

string

Project name

Project name.

 

Tracker

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Tracker Id

Tracker Id.

name

string

Tracker

Tracker.

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Id

Status Id.

name

string

Status

Status.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

Priority Id.

name

string

Priority

Priority.

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

Author Id.

name

string

Author

Author.

 


 

ListIssuesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

issues

array of (IssueResponse)

Issues

Issues.


 

ListPrioritiesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

issue_priorities

array of (ProjectResponse)

Projects

Priorities.


 

ListProjectsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

projects

array of (ProjectResponse)

Projects

Projects.


 

ListUsersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

users

array of (UserResponse)

Users

Users.


 

ProjectResponse

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.


 

UpdateIssueRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

issue

Issue

 

 

 

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.

 


 

UserResponse

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.

mail

string

Email

Email.

created_on

string(date-time)

Created on

Created on.

last_login_on

string(date-time)

Last login

Last login.