Validation
All URIs are relative to http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| homePage | get / | fetch valimate api information |
| testCaseValidationState | get /testcasevalidationstate/{tucid} | check validation state |
| validateTestCase | post /validatetestcase | send a test case for validation to valimate |
| validateTestCaseRequest | post /validatetestcaserequest | validate request data |
homePage
Fetch ValiMate API information
This endpoint returns information on the ValiMate instance handling the request such as the ValiMate version.
Parameters
This endpoint does not need any parameter.
Return type
String
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
testCaseValidationState
Check validation state
This entry point provides the state of a registered test use case. To check the state ValiMate needs the unique runId that was provided in the request during registering a test use case via the entry point “validateTestCase”.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tucId | UUID | [default to null] |
Return type
TestCaseValidationStateResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
validateTestCase
Send a test case for validation to ValiMate
This entry point is to register a request for the validation of a test use case (TUC). ValiMate checks if the requested data is in the correct format and stores it in the database. Afterwards it passes the request to the validation queue and answers to the sender immediately with an Ok Status code (200). Once validation is completed, ValiMate sends a validation result response to the call back URL that was configured in the request.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| TestCaseValidationPM | TestCaseValidationPM |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
validateTestCaseRequest
Validate request data
This entry point is to validate the format of the request data for the validation of a test use case (TUC). ValiMate only checks the format of the requested data and returns with an Ok Status code (200) if everything is correct.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| TestCaseValidationPM | TestCaseValidationPM |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined