qrapids backlog Services

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: 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 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"
}

The project_id paremeter is comming from the Backlog Id attribute from the project, it can be customised in the Products configuration form. If the project does not have a backlog id, the product_id will be filled with the project id used by Q-Rapids Tool for identifying the assessed projects (the text used for the indexes suffix in the Elastic).

Import Milestones

Example of the REST API endpoint

REQUEST

curl -X GET ‘<qr-issuetracker-url>/milestones?project_id=PR_X12&date_from=2019-08-01’

date_from is optional:

• filled: the result is the list of milestones from this day
• not filled: the result is the list of all milestones associated to the project

RESPONSE

[{
     "date":"2019-08-04",
     "name": "Version 1.3",
     "description": "Version 1.3 adding new features",
     "type":"Release"
},{
     "date": "2019-08-21",
     "name": "Version 1.4",
     "description":"Version 1.4 adding new features",
     "type": "Release"
},{
     "date":"2019-09-10",
     "name":"Version 1.5",
     "description": "Version 1.5 adding new features",
     "type": "Release"
}]

Import Phases

Example of the REST API endpoint

REQUEST

curl -X GET ‘<qr-issuetracker-url>/phases?project_id=PR_X12&date_from=2019-09-01’

date_from is optional:

• filled: the result is the list of phases which start from this day (excluded)
• not filled: the result is the list of all phases associated to the project

RESPONSE

[{
     "dateFrom": "2019-04-01",
     "dateTo": "2019-04-30",
     "name": "Project set-up",
     "description": "Eliciting project goals & setting-up the infrastruture and teams",
},{
     "dateFrom": "2019-05-01",
     "dateTo": "2019-05-15",
     "name": "Design",
     "description": "Defining project requirements and initial design",
},{
     "dateFrom": "2019-05-16",
     "dateTo": "2019-09-30",
     "name": "Development",
     "description": "Development, Testing, and Releasing",
}]