Connectors Reference

Easy Redmine

Easy Redmine is a web based tool for software project management.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ListIssues ()

List issues

CreateIssue (CreateIssueRequest issue)

Create a task

GetIssue (string issue_id)

Get task by ID

UpdateIssue (string issue_id, UpdateIssueRequest issue)

Update a task

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

ListPriorities ()

List priorities

 

Triggers:

Name

Summary

OnNewProject ()

When a project is created

OnNewIssue (string project_id)

When a task is created

OnUpdatedIssue (string project_id)

When a task is updated

 

Objects:

Name

Summary

CreateIssueRequest

 

CreateProjectRequest

 

CreateProjectResponse

 

GetIssueResponse

 

IssueResponse

 

ListIssuesResponse

 

ListPrioritiesResponse

 

ListProjectsResponse

 

ListUsersResponse

 

PriorityResponse

 

ProjectResponse

 

UpdateIssueRequest

 

UserResponse

 

 

Actions:

ListIssues

Summary: List issues

Description: List issues

 

Syntax:

EasyRedmine.ListIssues ()

 

Returns:

          Type:ListIssuesResponse

 

CreateIssue

Summary: Create a task

Description: Create a task

 

Syntax:

EasyRedmine.CreateIssue (CreateIssueRequest issue)

 

Parameters:

Name

Type

Summary

Required

Related Action

issue

CreateIssueRequest

 

 

True

 

Returns:

          Type:GetIssueResponse

 

GetIssue

Summary: Get task by ID

Description: Get task by ID

 

Syntax:

EasyRedmine.GetIssue (string issue_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

issue_id

string

(Issue)

Issue

True

 

Returns:

          Type:GetIssueResponse

 

UpdateIssue

Summary: Update a task

Description: Update a task

 

Syntax:

EasyRedmine.UpdateIssue (string issue_id, UpdateIssueRequest issue)

 

Parameters:

Name

Type

Summary

Required

Related Action

issue_id

string

(Issue ID)

Issue ID

True

ListIssues

issue

UpdateIssueRequest

 

 

True

 

Returns:

          Type:string

 

ListProjects

Summary: List projects

Description: List projects

 

Syntax:

EasyRedmine.ListProjects ()

 

Returns:

          Type:ListProjectsResponse

 

CreateProject

Summary: Create a project

Description: Create a project

 

Syntax:

EasyRedmine.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:

EasyRedmine.GetProject (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project)

Project

True

 

Returns:

          Type:ProjectResponse

 

ListUsers

Summary: List users

Description: List users

 

Syntax:

EasyRedmine.ListUsers ()

 

Returns:

          Type:ListUsersResponse

 

GetUser

Summary: Get user by ID

Description: Get user by ID

 

Syntax:

EasyRedmine.GetUser (string user_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

user_id

string

(User)

User

True

 

Returns:

          Type:UserResponse

 

ListPriorities

Summary: List priorities

Description: List priorities

 

Syntax:

EasyRedmine.ListPriorities ()

 

Returns:

          Type:ListPrioritiesResponse

 

Triggers:

Trigger OnNewProject

Summary: When a project is created

Description: When a project is created

 

Syntax:

EasyRedmine.OnNewProject ()

 

Returns:

          Type:ListProjectsResponse

 

Trigger OnNewIssue

Summary: When a task is created

Description: When a task is created

 

Syntax:

EasyRedmine.OnNewIssue (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project ID)

Project ID

True

ListProjects

 

Returns:

          Type:ListIssuesResponse

 

Trigger OnUpdatedIssue

Summary: When a task is updated

Description: When a task is updated

 

Syntax:

EasyRedmine.OnUpdatedIssue (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project ID)

Project ID

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 ID

Project ID

priority_id

string

Priority ID

Priority ID

subject

string

Subject

Subject

description

string

Description

Description

start_date

string(date-time)

Start date

yyyy-MM-dd

due_date

string(date-time)

Due date

yyyy-MM-dd

estimated_hours

number(float)

Estimated hours

Estimated hours

 


 

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 ID

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

 

name

string

Project name

 

identifier

string

Identifier

Unique identifier for the project

description

string

Description

 

homepage

string

Homepage

 

status

integer(int32)

Status

 

author

Author

 

 

created_on

string(date-time)

Created on

yyyy-MM-ddTHH:mm:ss.fffZ

updated_on

string(date-time)

Updated on

yyyy-MM-ddTHH:mm:ss.fffZ

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

Author Id

name

string

Author

Username of author

 


 

GetIssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Task Id

 

project

Project

 

 

tracker

Tracker

 

 

status

Status

 

 

priority

Priority

 

 

author

Author

 

 

subject

string

Subject

 

description

string

Description

 

start_date

string

Start date

 

done_ratio

integer(int32)

Done ratio

 

spent_hours

number(float)

Spent hours

 

total_spent_hours

number(float)

Total spent hours

 

created_on

string(date-time)

Created on

yyyy-MM-ddTHH:mm:ss.fffZ

updated_on

string(date-time)

Updated on

yyyy-MM-ddTHH:mm:ss.fffZ

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

 

name

string

Project name

 

 

Tracker

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Tracker Id

 

name

string

Tracker

 

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Id

 

name

string

Status

 

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

 

name

string

Priority

 

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

User ID of author.

name

string

Author

Username of author.

 


 

IssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Task Id

 

project

Project

 

 

tracker

Tracker

 

 

status

Status

 

 

priority

Priority

 

 

author

Author

 

 

subject

string

Subject

 

description

string

Description

 

start_date

string

Start date

 

done_ratio

integer(int32)

Done ratio

 

created_on

string(date-time)

Created on

yyyy-MM-ddTHH:mm:ss.fffZ

updated_on

string(date-time)

Updated on

yyyy-MM-ddTHH:mm:ss.fffZ

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

 

name

string

Project name

 

 

Tracker

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Tracker Id

 

name

string

Tracker

 

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Id

 

name

string

Status

 

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

 

name

string

Priority

 

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

User ID of author

name

string

Author

Username of 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 (PriorityResponse)

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


 

PriorityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Priority Id

Priority Id

name

string

Name

Name


 

ProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project ID

 

name

string

Project name

 

identifier

string

Identifier

Unique identifier for the project.

description

string

Description

 

homepage

string

Homepage

 

status

integer(int32)

Status

 

author

Author

 

 

created_on

string(date-time)

Created on

yyyy-MM-ddTHH:mm:ss.fffZ

updated_on

string(date-time)

Updated on

yyyy-MM-ddTHH:mm:ss.fffZ

start_date

string(date-time)

Start date

yyyy-MM-dd

due_date

string(date-time)

Due date

yyyy-MM-dd

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Author Id

 

name

string

Author

 

 


 

UpdateIssueRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

issue

Issue

 

 

 

Issue

Summary:

Description:

 

          Properties:

Name

Type

Summary

project_id

string

Project ID

Project ID

priority_id

string

Priority ID

Priority ID

subject

string

Subject

Subject

description

string

Description

Description

status_id

string

Status

Status  Values: [New, Estimated, Approved, Realisation, Consultation, To check, Passive, Done, Cancelled, Sequence pending]

assigned_to_id

string

Assign to ID

User to be assigned this task

start_date

string(date-time)

Start date

yyyy-MM-dd

due_date

string(date-time)

Due date

yyyy-MM-dd

estimated_hours

number(float)

Estimated hours

Estimated hours

 


 

UserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

User Id

 

login

string

Login

 

firstname

string

First name

 

lastname

string

Last name

 

mail

string

Email

 

created_on

string(date-time)

Created on

 

last_login_on

string(date-time)

Last login

 

api_key

string

API key

 

status

integer(int32)

Status

 

easy_user_type

Easy_user_type

 

 

language

string

Language

 

 

Easy_user_type

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

User type Id

 

name

string

User type name