ReqSuite® QC API

Authentication

POST
/token

With this method you get an access token, which you must use as the key for authentication using Bearer for the other methods.

Request:
grant_type=password&username=max.mustermann&password=myPassword1234

Response:

{"access_token":"TikwwVdL1jQyVUP4MrZrTM56eAAK1lq6woY7qRCXDrR3GPcxn4Y17qGwNbqLJsaxANLK_cpovo-iE45M7Kbn74751j0LynQI55AK4piYVfAaIBF-mUjMOCvQhYGyR98yZd_cjr6O-DHZA1KNbOvs0jv-YOkREaBQrca0of_JtRlkXz17Ke0wzj_P43zCz5_2uYXFd2Xcf38V0NU0Dw1vmlQX2FO9IdaIfQ7v5m6XYPVFXZHOtnZ0KDX9_71LbYdp-p_EE6rL9tJPJRbt6bvJW8PuHmKia7k5DvTgPtfVgIlHpq4jNw72vG-QSr6fhkpc5_UQ7hTX6n-aSRZ2fXwY3iLg03dA7BTG4Tu9lvYTxyHYT8XYBSLY4yqtYaAfMCT8HW_3HqUzmu8qWRoQ4Bhxc6l4J0QXEJ6UnUVZCUjjuaL9yO0b-Xl_2cBZt0PhTYOtqS-CBATWhCwScqJvvOa_79dgSw_hghZte4UiCItjY2ZX9iHgt9fUxsLM5yDjekxfWE0E0tc4iY72eRJeE6hHyCMOeGhFHeZQ","token_type":"bearer","expires_in":31535999,"as:client_id":"","userName":"max.mustermann","userId":"1","TenantId":"1","ReqSuiteRole":"TenantAdmin",".issued":"Thu, 30 Aug 2018 13:18:53 GMT",".expires":"Fri, 30 Aug 2019 13:18:53 GMT"}

Perform Checks

POST
/api/External/QC/Quality/{lang}

With this method you get results of a linguistic quality check for requirements in the specified language {lang}, whereby this is currently possible in German (DE) or English (EN).

Request:
[
   {
	"id": "1287",
	"text" : "The system must provide the user with the ability to save his data."
   },
   {
	"id": "1288",
	"text" : "The system must be able to calculate the user's data."
   }
]

Response:

   {
   "$id": "1",
   "$type": "ReqSuite.API.Data.RSCheckResult, ReqSuiteWeb",
   "results": [
	{
		"$id": "2",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1287",
		"text": "The system must provide the user with the ability to save his data.",
		"comment": "The sentence \"The system must provide the us...\" is imprecisely described because of the unspecific word \"data\". "
	},
	{
		"$id": "3",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1288",
		"text": "The system must be able to calculate the user's data.",
		"comment": "The sentence \"The system must be able to cal...\" is incomplete due to a missing statement about the criteria (according to what?) for the verb \"calculate\". "
	}
   ],
   "checkedWords": 23,
   "timeStamp": "2018-09-02T09:47:12.692Z",
   "costs": "0,02 €"
}
POST
/api/External/QC/Similarity/{lang}

Use this method to get results of a linguistic similarity search for requirements in the specified language {lang}, which currently works for German (DE) and English (EN).

Request:
[
   {
	"id": "1287",
	"text" : "If the status changes to critical, the system must display a warning."
   },
   {
	"id": "1288",
	"text" : "When the status is critical, the system should display a warning to the user."
   }
]

Response:

{
   "$id": "1",
   "$type": "ReqSuite.API.Data.RSCheckResult, ReqSuiteWeb",
   "results": [
	{
		"$id": "2",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1287",
		"text": "If the status changes to critical, the system must display a warning.",
		"comment": "The requirement has a 83.33 % similarity with the requirement 1288. \"When the status is critical, the system should dis...\". "
	},
	{
		"$id": "3",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1288",
		"text": "When the status is critical, the system should display a warning to the user.",
		"comment": "The requirement has a 83.33 % similarity with the requirement 1287. \"If the status changes to critical, the system must...\". "
	}
   ],
   "checkedWords": 26,
   "timeStamp": "2018-09-02T09:49:40.116Z",
   "costs": "0,03 €"
}

Query Credit

GET
/api/External/QC/Contingent

With this method you receive the status of your current remaining credit, which you can use for the language tests of your requirements.

Request:
-

Response:

96,83 €