Skip to content

qrapids backlog Services

Aleix Balletbó edited this page May 27, 2019 · 20 revisions

Connection to the Backlog Tool

qrapids-backlog RESTful services are used to connect the dashboard with a concrete Backlog Tool. The dashoard uses this connection to:

  • export the generated QRs.
  • know the list of milestones for a project (under development): Milestone is referring to important dates for the project (internal releases, releases, quality check points,...).
  • Know the list of phases for a project (under development): A phase is any kind of period of time (project phases, sprints, ...).

In order to configure the connection to these services, you need to configure the backlog.url in the application.properties file (detailed information in Dashboard Configuration File)

Export QR service

Example of the REST API endpoint

REQUEST

curl -XPOST <qr-issuetracker URL>/createIssue -H 'Content-Type: application/json' -d '
{
     "issue_summary": "QRAPIDS: This is a test issue",
     "issue_description": "Lorem ipsum",
     "issue_type": "Story",
     "project_id": "testproject",
     "decision_rationale": "Lorem ipsum"
}'

RESPONSE

{
     "issue_url": "https://<your jira url>/rest/api/latest/issue/201860",
     "issue_id": "RPA-425"
}

Import Milestones

Example of the REST API endpoint

REQUEST

curl -XPOST <qr-issuetracker URL>/milestones -H 'Content-Type: application/json' -d '
{
     "project_id": "PR_X12",
}'

RESPONSE

[{
     "milestone_date": "01/04/2019",
     "milestone_description": "Version 1.2.5"
     "milestone_type": "Internal release",
},{
     "milestone_date": "30/06/2019",
     "milestone_description": "Version 1.3"
     "milestone_type": "Release",
}]

Import Phases

Example of the REST API endpoint

REQUEST

curl -XPOST <qr-issuetracker URL>/phases -H 'Content-Type: application/json' -d '
{
     "project_id": "PR_X12",
}'

RESPONSE

[{
     "date_from": "01/04/2019",
     "date_to": "07/04/2019"
     "phase_description": "Srpint 23",
},{
     "date_from": "08/04/2019",
     "date_to": "14/04/2019"
     "phase_description": "Srpint 24",
},{
     "date_from": "15/04/2019",
     "date_to": "21/04/2019"
     "phase_description": "Srpint 25",
},{
     "date_from": "22/04/2019",
     "date_to": "28/04/2019"
     "phase_description": "Srpint 26",
}]

Clone this wiki locally