mateo-api-controller

addMateoInstance

Code samples

URL obj = new URL("http://localhost:8083/api/mateo/add?mateoUrl=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/mateo/add

Parameters

Name	In	Type	Required	Description
mateoUrl	query	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

getMateos

Code samples

URL obj = new URL("http://localhost:8083/api/mateo/all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/mateo/all

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

This operation does not require authentication

deleteMateoInstance

Code samples

URL obj = new URL("http://localhost:8083/api/mateo/remove?mateoUrl=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/mateo/remove

Parameters

Name	In	Type	Required	Description
mateoUrl	query	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

deleteAllMateoInstance

Code samples

URL obj = new URL("http://localhost:8083/api/mateo/remove-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/mateo/remove-all

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

job-api-controller

startJob

Code samples

URL obj = new URL("http://localhost:8083/api/job/start?scriptFile=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/job/start

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name	In	Type	Required	Description
scriptFile	query	string	true	none
priority	query	string	false	none
outputVariables	query	array[string]	false	none
body	body	object	false	none
» additionalProperties	body	string	false	none

Enumerated Values

Parameter	Value
priority	HIGH
priority	MEDIUM
priority	URGENT
priority	LOW
priority	DEFAULT

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

downloadReportAsZip

Code samples

URL obj = new URL("http://localhost:8083/api/job/result/download/zip?uuid=497f6eca-6276-4993-bfeb-53cbbbba6f08");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/job/result/download/zip

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

This operation does not require authentication

getJob

Code samples

URL obj = new URL("http://localhost:8083/api/job?uuid=497f6eca-6276-4993-bfeb-53cbbbba6f08");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/job

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	JobEntity

This operation does not require authentication

getJobsWithState

Code samples

URL obj = new URL("http://localhost:8083/api/job/state?jobStatus=QUEUED");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/job/state

Parameters

Name	In	Type	Required	Description
jobStatus	query	string	true	none

Enumerated Values

Parameter	Value
jobStatus	QUEUED
jobStatus	RUNNING
jobStatus	FINISHED
jobStatus	FAILED

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[JobEntity]	false	none	none
» id	string(uuid)	false	none	none
» scriptName	string	false	none	none
» inputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» outputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» status	string	false	none	none
» priority	string	false	none	none
» priorityValue	integer(int32)	false	none	none
» askedTimes	integer(int32)	false	none	none
» createDate	string(date-time)	false	none	none
» modifyDate	string(date-time)	false	none	none
» filePath	string	false	none	none
» filename	string	false	none	none
» testSetName	string	false	none	none
» resultLevel	string	false	none	none
» resultString	string	false	none	none
» startTime	string	false	none	none
» originFileName	string	false	none	none
» runIndex	string	false	none	none
» vtfVersion	string	false	none	none
» mateoInstanz	string	false	none	none

Enumerated Values

Property	Value
status	QUEUED
status	RUNNING
status	FINISHED
status	FAILED
priority	HIGH
priority	MEDIUM
priority	URGENT
priority	LOW
priority	DEFAULT

This operation does not require authentication

getFinishedJobs

Code samples

URL obj = new URL("http://localhost:8083/api/job/state/finished");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/job/state/finished

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[JobEntity]	false	none	none
» id	string(uuid)	false	none	none
» scriptName	string	false	none	none
» inputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» outputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» status	string	false	none	none
» priority	string	false	none	none
» priorityValue	integer(int32)	false	none	none
» askedTimes	integer(int32)	false	none	none
» createDate	string(date-time)	false	none	none
» modifyDate	string(date-time)	false	none	none
» filePath	string	false	none	none
» filename	string	false	none	none
» testSetName	string	false	none	none
» resultLevel	string	false	none	none
» resultString	string	false	none	none
» startTime	string	false	none	none
» originFileName	string	false	none	none
» runIndex	string	false	none	none
» vtfVersion	string	false	none	none
» mateoInstanz	string	false	none	none

Enumerated Values

Property	Value
status	QUEUED
status	RUNNING
status	FINISHED
status	FAILED
priority	HIGH
priority	MEDIUM
priority	URGENT
priority	LOW
priority	DEFAULT

This operation does not require authentication

isOnline

Code samples

URL obj = new URL("http://localhost:8083/api/job/online");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/job/online

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

getJobs

Code samples

URL obj = new URL("http://localhost:8083/api/job/all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/job/all

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[JobEntity]	false	none	none
» id	string(uuid)	false	none	none
» scriptName	string	false	none	none
» inputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» outputVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» status	string	false	none	none
» priority	string	false	none	none
» priorityValue	integer(int32)	false	none	none
» askedTimes	integer(int32)	false	none	none
» createDate	string(date-time)	false	none	none
» modifyDate	string(date-time)	false	none	none
» filePath	string	false	none	none
» filename	string	false	none	none
» testSetName	string	false	none	none
» resultLevel	string	false	none	none
» resultString	string	false	none	none
» startTime	string	false	none	none
» originFileName	string	false	none	none
» runIndex	string	false	none	none
» vtfVersion	string	false	none	none
» mateoInstanz	string	false	none	none

Enumerated Values

Property	Value
status	QUEUED
status	RUNNING
status	FINISHED
status	FAILED
priority	HIGH
priority	MEDIUM
priority	URGENT
priority	LOW
priority	DEFAULT

This operation does not require authentication

removeJob

Code samples

URL obj = new URL("http://localhost:8083/api/job/remove?uuid=497f6eca-6276-4993-bfeb-53cbbbba6f08");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/job/remove

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

removeAllJobs

Code samples

URL obj = new URL("http://localhost:8083/api/job/remove-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/job/remove-all

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

This operation does not require authentication

Schemas

JobEntity

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "scriptName": "string",
  "inputVariables": {
    "property1": "string",
    "property2": "string"
  },
  "outputVariables": {
    "property1": "string",
    "property2": "string"
  },
  "status": "QUEUED",
  "priority": "HIGH",
  "priorityValue": 0,
  "askedTimes": 0,
  "createDate": "2019-08-24T14:15:22Z",
  "modifyDate": "2019-08-24T14:15:22Z",
  "filePath": "string",
  "filename": "string",
  "testSetName": "string",
  "resultLevel": "string",
  "resultString": "string",
  "startTime": "string",
  "originFileName": "string",
  "runIndex": "string",
  "vtfVersion": "string",
  "mateoInstanz": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
scriptName	string	false	none	none
inputVariables	object	false	none	none
» additionalProperties	string	false	none	none
outputVariables	object	false	none	none
» additionalProperties	string	false	none	none
status	string	false	none	none
priority	string	false	none	none
priorityValue	integer(int32)	false	none	none
askedTimes	integer(int32)	false	none	none
createDate	string(date-time)	false	none	none
modifyDate	string(date-time)	false	none	none
filePath	string	false	none	none
filename	string	false	none	none
testSetName	string	false	none	none
resultLevel	string	false	none	none
resultString	string	false	none	none
startTime	string	false	none	none
originFileName	string	false	none	none
runIndex	string	false	none	none
vtfVersion	string	false	none	none
mateoInstanz	string	false	none	none

Enumerated Values

Property	Value
status	QUEUED
status	RUNNING
status	FINISHED
status	FAILED
priority	HIGH
priority	MEDIUM
priority	URGENT
priority	LOW
priority	DEFAULT

Files

api-doc.md

Latest commit

History

api-doc.md

File metadata and controls

mateo-api-controller

addMateoInstance

Parameters

Responses

getMateos

Responses

Response Schema

deleteMateoInstance

Parameters

Responses

deleteAllMateoInstance

Responses

job-api-controller

startJob

Parameters

Enumerated Values

Responses

downloadReportAsZip

Parameters

Responses

Response Schema

getJob

Parameters

Responses

getJobsWithState

Parameters

Enumerated Values

Responses

Response Schema

Enumerated Values

getFinishedJobs

Responses

Response Schema

Enumerated Values

isOnline

Responses

getJobs

Responses

Response Schema

Enumerated Values

removeJob

Parameters

Responses

removeAllJobs

Responses

Schemas

JobEntity

Properties

Enumerated Values