ReqSuite® QC API

Authentifizierung

POST
/token

Mit dieser Methode erhalten Sie einen Access Token, den Sie bei den weiteren Methoden als Schlüssel zur Authentifizierung mittels Bearer verwenden müssen.

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

Checks durchführen

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

Mit dieser Methode erhalten Sie Ergebnisse einer sprachlichen Qualitätsprüfung für Anforderungen in der angegebenen Sprache {lang}, wobei dies aktuell in Deutsch (DE) oder Englisch (EN) möglich ist.

Request:
[
   {
	"id": "1287",
	"text" : "Das System muss dem Benutzer die Möglichkeit bieten, seine Daten zu speichern."
   },
   {
	"id": "1288",
	"text" : "Das System muss fähig sein, die Angaben des Benutzers zu berechnen."
   }
]

Response:

{
   "$id": "1",
   "$type": "ReqSuite.API.Data.RSCheckResult, ReqSuiteWeb",
   "results": [
	{
		"$id": "2",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1287",
		"text": "Das System muss dem Benutzer die Möglichkeit bieten, seine Daten zu speichern.",
		"comment": "Der Satz \"Das System muss dem Benutzer d...\" ist aufgrund der Verwendung des nicht konkretisierten Wortes \"Daten\" (was genau?) unpräzise. "
	},
	{
		"$id": "3",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1288",
		"text": "Das System muss fähig sein, die Angaben des Benutzers zu berechnen.",
		"comment": "Der Satz \"Das System muss fähig sein, di...\" ist aufgrund einer fehlenden Kriterienangabe (anhand was?) zum Verb \"berechnen\" nicht vollständig. "
	},
	{
		"$id": "4",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "",
		"text": "",
		"comment": "Tipp: Den Begriff \"Angaben\" sollten Sie - sofern noch nicht geschehen - in Ihrem Projekt als Element definieren."
	}
   ],
   "checkedWords": 23,
   "timeStamp": "2018-09-02T08:47:03.324Z",
   "costs": "0,02 €"
}
POST
/api/External/QC/Similarity/{lang}

Mit dieser Methode erhalten Sie Ergebnisse einer sprachlichen Ähnlichkeitssuche für Anforderungen in der angegebenen Sprache {lang}, wobei dies aktuell für Deutsch (DE) und Englisch (EN) funktioniert.

Request:
[
   {
	"id": "1287",
	"text" : "Falls der Status auf kritisch wechselt, muss das System eine Warnung anzeigen."
   },
   {
	"id": "1288",
	"text" : "Wenn der Status kritisch ist, soll das System dem Nutzer eine Warnung anzeigen."
   }
]

Response:

{
   "$id": "1",
   "$type": "ReqSuite.API.Data.RSCheckResult, ReqSuiteWeb",
   "results": [
	{
		"$id": "2",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1287",
		"text": "Falls der Status auf kritisch wechselt, muss das System eine Warnung anzeigen.",
		"comment": "Die Anforderung hat eine 83,33 % Ähnlichkeit mit Anforderung 1288. \"Wenn der Status kritisch ist, soll das System dem Nutzer eine Warnung anzeigen.\". "
	},
	{
		"$id": "3",
		"$type": "ReqSuite.API.Data.RSExternalContent, ReqSuiteWeb",
		"id": "1288",
		"text": "Wenn der Status kritisch ist, soll das System dem Nutzer eine Warnung anzeigen.",
		"comment": "Die Anforderung hat eine 83,33 % Ähnlichkeit mit Anforderung 1287. \"Falls der Status auf kritisch wechselt, muss das System eine Warnung anzeigen.\". "
	}
   ],
   "checkedWords": 25,
   "timeStamp": "2018-09-02T08:50:50.090Z",
   "costs": "0,03 €"
}

Guthaben abfragen

GET
/api/External/QC/Contingent

Mit dieser Methode erhalten Sie den Stand Ihres aktuellen Restguthabens, das Sie für die sprachlichen Prüfungen Ihrer Anforderungen verwenden können.

Request:
-

Response:

96,83 €