Simulation Hub 1.0 API Doc

FVA Simulation Hub v1.0.0

The FVA Simulation Hub is an application that is independent of the FVA-Workbench and can be ran as a service on a server. Any clients can send calculation tasks to the Simulation Hub via requests. The Simulation Hub receives the jobs and distributes them to several instances of the FVA-Workbench.

Endpoints

Health

Responses

Status	Meaning	Description	Schema
200	OK	OK	HealthResponse
401	Unauthorized	Unauthorized	None

This operation does not require authentication

Request

URL obj = new URL("/actuator/health");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/actuator/health',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/actuator/health', headers = headers)

print(r.json())

Response

json

{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP",
      "details": {}
    },
    "nodes": {
      "status": "UP",
      "details": {}
    },
    "ping": {
      "status": "UP"
    }
  }
}

Info

Responses

Status	Meaning	Description	Schema
200	OK	OK	InfoResponse
401	Unauthorized	Unauthorized	None

This operation does not require authentication

Request

URL obj = new URL("/actuator/info");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/actuator/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/actuator/info', headers = headers)

print(r.json())

Response

json

{
  "application": {
    "name": "FVA Simulation Hub",
    "version": "1.0.0",
    "revision": 57685,
    "buildDate": "2022-05-27T13:50:08.523+0100",
    "vendor": "FVA GmbH"
  }
}

Login

Body parameter

{
  "username": "user1",
  "password": "password1"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginRequest	true	none
» username	body	string	true	The username of the user.
» password	body	string	true	The password of the user.

Responses

Status	Meaning	Description	Schema
200	OK	OK	LoginResponse
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/auth/login");
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());

Request

const inputBody = '{
  "username": "user1",
  "password": "password1"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/1.0/auth/login',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/1.0/auth/login', headers = headers)

print(r.json())

Response

json

{
  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyMiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hcGkvMS4wL2F1d"
}

Simulate Work (Create)

Body parameter

{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "duration": 1
}

Parameters

Name	In	Type	Required	Description
body	body	SimulateWorkRequest	true	none
» name	body	string	false	Name assigned to the request (to display in overviews).
» classifiers	body	[RequestClassifier]	false	A list of classifiers for the request.
»» type	body	string	true	The type of the classifier
»» value	body	string	true	The value of the classifier
» duration	body	integer(int64)	true	Duration of the simulated job in seconds

Enumerated Values

Parameter	Value
»» type	VERSION
»» type	PRIORITY
»» type	LABELS

Responses

Status	Meaning	Description	Schema
201	Created	Created	SimulateWorkResponse
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
423	Locked	Locked: The requested resource is currently locked.	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/simulate-work/create");
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());

Request

const inputBody = '{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "duration": 1
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/simulate-work/create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/1.0/workbench/task/simulate-work/create', headers = headers)

print(r.json())

Simulate Work (Result)

Parameters

Name	In	Type	Required	Description
taskId	path	string	true	The id of the task to retrieve.
timeout	query	integer	false	The maximum time to wait for the task to finish in seconds (use the value 0 to get an immediate response)

Responses

Status	Meaning	Description	Schema
200	OK	OK	SimulateWorkResponse
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/simulate-work/{taskId}/result");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/simulate-work/{taskId}/result',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/simulate-work/{taskId}/result', headers = headers)

print(r.json())

Response

json

{
  "status": "WAITING",
  "id": "string",
  "message": "string"
}

Execute Batch Job (Create)

Body parameter

{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "additionalFiles": [
    {
      "content": "string",
      "filename": "reportTemplate.wbrep"
    }
  ],
  "inputModel": {
    "content": "UEsDBAoAAAAAAOCItFQAAAAAAAAAAAAAAAAPACQAcmVzdWxGCKBLABJSlo773Se4TzZ8QhcIhIIZFJikOmJmrHpbvH+fR4eHu4eHu6//I/Py0S7JnkRZ+mvPxiP...",
    "type": "WBPZ"
  },
  "inputModelReference": {
    "type": "LOCAL_FILESYSTEM",
    "parameters": [
      {}
    ]
  },
  "inputScripts": [
    {
      "content": "string"
    }
  ],
  "variablesToInject": [
    {
      "key": "Torque",
      "value": 320
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ExecuteBatchJobRequest	true	none
» name	body	string	false	Name assigned to the request (to display in overviews).
» classifiers	body	[RequestClassifier]	false	A list of classifiers for the request.
»» type	body	string	true	The type of the classifier
»» value	body	string	true	The value of the classifier
» additionalFiles	body	[WorkbenchBatchAdditionalFile]	false	Additional files that can be referenced in the script files
»» content	body	string	true	The content of the file encoded with Base64
»» filename	body	string	true	The name of the file for referencing in the script files
» inputModel	body	WorkbenchModelFile	false	Workbench model file
»» content	body	string	true	The content of the file encoded with Base64
»» type	body	string	true	The file type of the Workbench model
» inputModelReference	body	WorkbenchModelReference	false	Workbench model reference
»» type	body	string	true	The file type of the Workbench model reference
»» parameters	body	[WorkbenchModelReferenceParameter]	false	Parameters for the workbench model reference
»»» key	body	string	true	The name of the variable.
»»» value	body	string	true	The value of the variable.
» inputScripts	body	[WorkbenchScriptFile]	true	The script files to be executed in the batch job
»» content	body	string	true	The content of the file encoded with Base64
» variablesToInject	body	[VariableToInject]	false	Freely definable variables that are provided in the script to be executed
»» key	body	string	true	The name of the variable.
»» value	body	string	true	The value of the variable.

Enumerated Values

Parameter	Value
»» type	VERSION
»» type	PRIORITY
»» type	LABELS
»» type	WBPZ
»» type	WBPX
»» type	WBPS
»» type	REXS
»» type	LOCAL_FILESYSTEM

Responses

Status	Meaning	Description	Schema
201	Created	Created	ExecuteBatchJobResponse
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
423	Locked	Locked: The requested resource is currently locked.	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/execute-batch-job/create");
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());

Request

const inputBody = '{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "additionalFiles": [
    {
      "content": "string",
      "filename": "reportTemplate.wbrep"
    }
  ],
  "inputModel": {
    "content": "UEsDBAoAAAAAAOCItFQAAAAAAAAAAAAAAAAPACQAcmVzdWxGCKBLABJSlo773Se4TzZ8QhcIhIIZFJikOmJmrHpbvH+fR4eHu4eHu6//I/Py0S7JnkRZ+mvPxiP...",
    "type": "WBPZ"
  },
  "inputModelReference": {
    "type": "LOCAL_FILESYSTEM",
    "parameters": [
      {}
    ]
  },
  "inputScripts": [
    {
      "content": "string"
    }
  ],
  "variablesToInject": [
    {
      "key": "Torque",
      "value": 320
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/execute-batch-job/create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/1.0/workbench/task/execute-batch-job/create', headers = headers)

print(r.json())

Execute Batch Job (Result)

Parameters

Name	In	Type	Required	Description
taskId	path	string	true	The id of the task to retrieve.
timeout	query	integer	false	The maximum time to wait for the task to finish in seconds (use the value 0 to get an immediate response)

Responses

Status	Meaning	Description	Schema
200	OK	OK	ExecuteBatchJobResponse
201	Created	Created	None
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/execute-batch-job/{taskId}/result");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/execute-batch-job/{taskId}/result',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/execute-batch-job/{taskId}/result', headers = headers)

print(r.json())

Response

json

{
  "status": "WAITING",
  "id": "string",
  "outputFiles": [
    {
      "content": "string",
      "directory": "string",
      "filename": "result_report.html"
    }
  ],
  "batchExecutionStatus": "OK"
}

Task List

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page to be returned.
size	query	integer	false	The number of items to be returned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchTaskPage
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/list");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/list', headers = headers)

print(r.json())

Response

json

{
  "content": [
    {
      "id": "string",
      "type": "SIMULATE_WORK",
      "name": "string",
      "priority": "HIGHEST",
      "creator": "string",
      "requestedDatetime": "string",
      "startedDatetime": "string",
      "endedDatetime": "string",
      "status": "WAITING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

Task List (Running)

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page to be returned.
size	query	integer	false	The number of items to be returned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchTaskPage
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/list/running");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/list/running',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/list/running', headers = headers)

print(r.json())

Response

json

{
  "content": [
    {
      "id": "string",
      "type": "SIMULATE_WORK",
      "name": "string",
      "priority": "HIGHEST",
      "creator": "string",
      "requestedDatetime": "string",
      "startedDatetime": "string",
      "endedDatetime": "string",
      "status": "WAITING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

Task List (Waiting)

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page to be returned.
size	query	integer	false	The number of items to be returned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchTaskPage
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/list/waiting");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/list/waiting',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/list/waiting', headers = headers)

print(r.json())

Response

json

{
  "content": [
    {
      "id": "string",
      "type": "SIMULATE_WORK",
      "name": "string",
      "priority": "HIGHEST",
      "creator": "string",
      "requestedDatetime": "string",
      "startedDatetime": "string",
      "endedDatetime": "string",
      "status": "WAITING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

Task

Parameters

Name	In	Type	Required	Description
taskId	path	string	true	The id of the task to retrieve.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchTask
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/{taskId}");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/task/{taskId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/task/{taskId}', headers = headers)

print(r.json())

Response

json

{
  "id": "string",
  "type": "SIMULATE_WORK",
  "name": "string",
  "priority": "HIGHEST",
  "creator": "string",
  "requestedDatetime": "string",
  "startedDatetime": "string",
  "endedDatetime": "string",
  "status": "WAITING"
}

Task (Cancel)

Parameters

Name	In	Type	Required	Description
taskId	path	string	true	The id of the task to retrieve.

Responses

Status	Meaning	Description	Schema
204	No Content	No Content: OK	None
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
409	Conflict	Conflict: Task could not be canceled.	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/task/{taskId}/cancel");
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());

Request

fetch('/api/1.0/workbench/task/{taskId}/cancel',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.delete('/api/1.0/workbench/task/{taskId}/cancel')

print(r.json())

Node Instance List

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page to be returned.
size	query	integer	false	The number of items to be returned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchInstancePage
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/instance/list");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/node/instance/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/node/instance/list', headers = headers)

print(r.json())

Response

json

{
  "content": [
    {
      "id": "string",
      "version": "string",
      "labels": [],
      "serverId": "string",
      "status": "PENDING",
      "working": true
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

Node Instance

Parameters

Name	In	Type	Required	Description
nodeId	path	string	true	The id of the node to retrieve.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchInstance
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/instance/{nodeId}");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/node/instance/{nodeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/node/instance/{nodeId}', headers = headers)

print(r.json())

Response

json

{
  "id": "string",
  "version": "string",
  "labels": [
    "string"
  ],
  "serverId": "string",
  "status": "PENDING",
  "working": true
}

Node Instance (Start)

Parameters

Name	In	Type	Required	Description
nodeId	path	string	true	The id of the node to retrieve.

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None
502	Bad Gateway	Bad Gateway	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/instance/{nodeId}/start");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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());

Request

fetch('/api/1.0/workbench/node/instance/{nodeId}/start',
{
  method: 'PATCH'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.patch('/api/1.0/workbench/node/instance/{nodeId}/start')

print(r.json())

Node Instance (Stop)

Parameters

Name	In	Type	Required	Description
nodeId	path	string	true	The id of the node to retrieve.

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None
502	Bad Gateway	Bad Gateway	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/instance/{nodeId}/stop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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());

Request

fetch('/api/1.0/workbench/node/instance/{nodeId}/stop',
{
  method: 'PATCH'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.patch('/api/1.0/workbench/node/instance/{nodeId}/stop')

print(r.json())

Node Server List

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page to be returned.
size	query	integer	false	The number of items to be returned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchServerPage
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/server/list");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/node/server/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/node/server/list', headers = headers)

print(r.json())

Response

json

{
  "content": [
    {
      "id": "string",
      "version": "string",
      "baseUrl": "string",
      "instances": [],
      "status": "PENDING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

Node Server

Parameters

Name	In	Type	Required	Description
nodeId	path	string	true	The id of the node to retrieve.

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkbenchServer
400	Bad Request	Bad Request: The parameters passed are not valid.	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error: Unexpected processing error	None

This operation does not require authentication

Request

URL obj = new URL("/api/1.0/workbench/node/server/{nodeId}");
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());

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/1.0/workbench/node/server/{nodeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/1.0/workbench/node/server/{nodeId}', headers = headers)

print(r.json())

Response

json

{
  "id": "string",
  "version": "string",
  "baseUrl": "string",
  "instances": [
    {
      "id": "string",
      "version": "string",
      "labels": [],
      "serverId": "string",
      "status": "PENDING",
      "working": true
    }
  ],
  "status": "PENDING"
}

Schemas

HealthResponse

Model with the properties for the response of the health endpoint.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The cumulative status of all components.
components	HealthComponents	false	none	A listing of all components that are included in the health status.

Enumerated Values

Property	Value
status	UP
status	DOWN

json

{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP",
      "details": {}
    },
    "nodes": {
      "status": "UP",
      "details": {}
    },
    "ping": {
      "status": "UP"
    }
  }
}

HealthComponents

Model with the properties of all Health components.

Properties

Name	Type	Required	Restrictions	Description
diskSpace	HealthDiskSpaceResponse	false	none	Information on checking for low disk space.
nodes	HealthNodesResponse	false	none	Information on checking for available FVA-Workbench instances.
ping	HealthPingResponse	false	none	Information about the availability of the application.

json

{
  "diskSpace": {
    "status": "UP",
    "details": {
      "total": 0,
      "free": 0,
      "threshold": 0,
      "exists": true
    }
  },
  "nodes": {
    "status": "UP",
    "details": {
      "totalInstances": 5,
      "runningInstances": 3
    }
  },
  "ping": {
    "status": "UP"
  }
}

HealthDiskSpaceResponse

Model with disk space check properties.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The status of this component.
details	HealthDiskSpaceDetails	false	none	Details about this component.

Enumerated Values

Property	Value
status	UP
status	DOWN

json

{
  "status": "UP",
  "details": {
    "total": 0,
    "free": 0,
    "threshold": 0,
    "exists": true
  }
}

HealthDiskSpaceDetails

Model with the detailed properties to check for low disk space.

Properties

Name	Type	Required	Restrictions	Description
total	integer(int64)	false	none	Total available disk space in bytes.
free	integer(int64)	false	none	The free space on the disk in bytes.
threshold	integer(int64)	false	none	The difference between available and free disk space in bytes. With more than 10 megabytes of free hard disk space, the Statue UP.
exists	boolean	false	none	Indicates whether the checked directory exists. By default, the installation directory is checked.

json

{
  "total": 0,
  "free": 0,
  "threshold": 0,
  "exists": true
}

HealthNodesResponse

Model with the properties to check for available FVA-Workbench instances.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The status of this component.
details	HealthNodesDetails	false	none	Details about this component.

Enumerated Values

Property	Value
status	UP
status	DOWN

json

{
  "status": "UP",
  "details": {
    "totalInstances": 5,
    "runningInstances": 3
  }
}

HealthNodesDetails

Model with the detail properties to check for available FVA-Workbench instances.

Properties

Name	Type	Required	Restrictions	Description
totalInstances	integer(int64)	false	none	The number of total instances.
runningInstances	integer(int64)	false	none	The number of running instances.

json

{
  "totalInstances": 5,
  "runningInstances": 3
}

HealthPingResponse

Model with the properties for checking the availability of the application.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The status of this component.

Enumerated Values

Property	Value
status	UP
status	DOWN

json

{
  "status": "UP"
}

InfoResponse

Model with the properties for the response of the info endpoint.

Properties

Name	Type	Required	Restrictions	Description
application	InfoApplication	false	none	Information about the application.

json

{
  "application": {
    "name": "FVA Simulation Hub",
    "version": "1.0.0",
    "revision": 57685,
    "buildDate": "2022-05-27T13:50:08.523+0100",
    "vendor": "FVA GmbH"
  }
}

InfoApplication

Information about the application.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the application.
version	string	false	none	The version of the application.
revision	string	false	none	The revision number of the application.
buildDate	string	false	none	The build date of the application.
vendor	string	false	none	The vendor of the application.

json

{
  "name": "FVA Simulation Hub",
  "version": "1.0.0",
  "revision": 57685,
  "buildDate": "2022-05-27T13:50:08.523+0100",
  "vendor": "FVA GmbH"
}

LoginRequest

Model with the properties for the login.

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	The username of the user.
password	string	true	none	The password of the user.

json

{
  "username": "user1",
  "password": "password1"
}

LoginResponse

Model with the properties for the response of the login.

Properties

Name	Type	Required	Restrictions	Description
accessToken	string	true	none	The access token for further requests.

json

{
  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyMiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hcGkvMS4wL2F1d"
}

ExecuteBatchJobRequest

Model with the properties for the execution of a batch job.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name assigned to the request (to display in overviews).
classifiers	RequestClassifiers	false	none	A list of classifiers for the request.
additionalFiles	[WorkbenchBatchAdditionalFile]	false	none	Additional files that can be referenced in the script files
inputModel	WorkbenchModelFile	false	none	The model file for the batch job
inputModelReference	WorkbenchModelReference	false	none	The model file for the batch job as a reference
inputScripts	[WorkbenchScriptFile]	true	none	The script files to be executed in the batch job
variablesToInject	[VariableToInject]	false	none	Freely definable variables that are provided in the script to be executed

json

{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "additionalFiles": [
    {
      "content": "string",
      "filename": "reportTemplate.wbrep"
    }
  ],
  "inputModel": {
    "content": "UEsDBAoAAAAAAOCItFQAAAAAAAAAAAAAAAAPACQAcmVzdWxGCKBLABJSlo773Se4TzZ8QhcIhIIZFJikOmJmrHpbvH+fR4eHu4eHu6//I/Py0S7JnkRZ+mvPxiP...",
    "type": "WBPZ"
  },
  "inputModelReference": {
    "type": "LOCAL_FILESYSTEM",
    "parameters": [
      {}
    ]
  },
  "inputScripts": [
    {
      "content": "string"
    }
  ],
  "variablesToInject": [
    {
      "key": "Torque",
      "value": 320
    }
  ]
}

ExecuteBatchJobResponse

Model with the properties for the response of a executed batch job.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The execution status of the request.
id	string	false	none	The identifier for later retrieval of the results
outputFiles	[WorkbenchBatchOutputFile]	false	none	The files that were generated when the Workbench Batch job was executed.
batchExecutionStatus	string	false	none	The result status of the batch execution.

Enumerated Values

Property	Value
status	WAITING
status	RUNNING
status	CANCELED
status	FINISHED
status	FAILED
batchExecutionStatus	OK
batchExecutionStatus	FAILED

json

{
  "status": "WAITING",
  "id": "string",
  "outputFiles": [
    {
      "content": "string",
      "directory": "string",
      "filename": "result_report.html"
    }
  ],
  "batchExecutionStatus": "OK"
}

RequestClassifiers

A list of classifiers for the request.

Properties

Name	Type	Required	Restrictions	Description
anonymous	[RequestClassifier]	false	none	A list of classifiers for the request.

json

[
  {
    "type": "VERSION",
    "value": "string"
  }
]

RequestClassifier

Request classifier

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The type of the classifier
value	string	true	none	The value of the classifier

Enumerated Values

Property	Value
type	VERSION
type	PRIORITY
type	LABELS

json

{
  "type": "VERSION",
  "value": "string"
}

SimulateWorkRequest

Model with the properties for the execution of a simulated job.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name assigned to the request (to display in overviews).
classifiers	RequestClassifiers	false	none	A list of classifiers for the request.
duration	integer(int64)	true	none	Duration of the simulated job in seconds

json

{
  "name": "string",
  "classifiers": [
    {
      "type": "VERSION",
      "value": "string"
    }
  ],
  "duration": 1
}

SimulateWorkResponse

Model with the properties for the response after running a simulated job.

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	The execution status of the request.
id	string	false	none	The identifier for later retrieval of the results
message	string	false	none	Information about the execution of the simulated job

Enumerated Values

Property	Value
status	WAITING
status	RUNNING
status	CANCELED
status	FINISHED
status	FAILED

json

{
  "status": "WAITING",
  "id": "string",
  "message": "string"
}

VariableToInject

Freely definable variables that are provided in the script to be executed for the execution of a batch job.

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	The name of the variable.
value	string	true	none	The value of the variable.

json

{
  "key": "Torque",
  "value": 320
}

WorkbenchBatchAdditionalFile

Additional file for batch jobs of various types

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	The content of the file encoded with Base64
filename	string	true	none	The name of the file for referencing in the script files

json

{
  "content": "string",
  "filename": "reportTemplate.wbrep"
}

WorkbenchBatchOutputFile

A file that was generated during a workbench batch job.

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	The content of the file encoded with Base64
directory	string	false	none	The relative path to the directory of the file
filename	string	true	none	The name of the file

json

{
  "content": "string",
  "directory": "string",
  "filename": "result_report.html"
}

WorkbenchModelFile

Workbench model file

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	The content of the file encoded with Base64
type	string	true	none	The file type of the Workbench model

Enumerated Values

Property	Value
type	WBPZ
type	WBPX
type	WBPS
type	REXS

json

{
  "content": "UEsDBAoAAAAAAOCItFQAAAAAAAAAAAAAAAAPACQAcmVzdWxGCKBLABJSlo773Se4TzZ8QhcIhIIZFJikOmJmrHpbvH+fR4eHu4eHu6//I/Py0S7JnkRZ+mvPxiP...",
  "type": "WBPZ"
}

WorkbenchModelReference

Workbench model reference

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The file type of the Workbench model reference
parameters	[WorkbenchModelReferenceParameter]	false	none	Parameters for the workbench model reference

Enumerated Values

Property	Value
type	LOCAL_FILESYSTEM

json

{
  "type": "LOCAL_FILESYSTEM",
  "parameters": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

WorkbenchModelReferenceParameter

Workbench model reference parameter.

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	The name of the variable.
value	string	true	none	The value of the variable.

json

{
  "key": "string",
  "value": "string"
}

WorkbenchScriptFile

Workbench script file

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	The content of the file encoded with Base64

json

{
  "content": "string"
}

WorkbenchTask

Model containing the properties for the response to the task endpoint.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The identifier of the task.
type	string	true	none	The type of the task.
name	string	false	none	The name of the task (only if it was specified with the request).
priority	string	true	none	The priority of the task.
creator	string	false	none	The name of the creator of the task (only if security was enabled).
requestedDatetime	string	true	none	The time the request was received.
startedDatetime	string	false	none	The time at which processing of the task started.
endedDatetime	string	false	none	The time at which the processing of the task was completed.
status	string	true	none	The status of the task.

Enumerated Values

Property	Value
type	SIMULATE_WORK
type	EXECUTE_BATCH_JOB
priority	HIGHEST
priority	HIGH
priority	NORMAL
priority	LOW
priority	LOWEST
status	WAITING
status	RUNNING
status	CANCELED
status	FINISHED
status	FAILED

json

{
  "id": "string",
  "type": "SIMULATE_WORK",
  "name": "string",
  "priority": "HIGHEST",
  "creator": "string",
  "requestedDatetime": "string",
  "startedDatetime": "string",
  "endedDatetime": "string",
  "status": "WAITING"
}

WorkbenchTaskPage

Model containing the properties for a page to respond to the task list endpoint.

Properties

Name	Type	Required	Restrictions	Description
content	[WorkbenchTask]	true	none	A list of the tasks on this page.
pageSize	integer(int64)	true	none	The number of maximum items on the page.
pageNumber	integer(int64)	true	none	The current page number.
totalElements	integer(int64)	true	none	The count of all elements.
totalPages	integer(int64)	true	none	The number of all pages considering all elements and the page size.
size	integer(int64)	true	none	The number of items in this page.
first	boolean	true	none	Indicates whether this is the first page of all items.
last	boolean	true	none	Indicates whether this is the last page of all items.

json

{
  "content": [
    {
      "id": "string",
      "type": "SIMULATE_WORK",
      "name": "string",
      "priority": "HIGHEST",
      "creator": "string",
      "requestedDatetime": "string",
      "startedDatetime": "string",
      "endedDatetime": "string",
      "status": "WAITING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

WorkbenchInstance

Model with the properties for Response to the node instance endpoint.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The identifier of the instance.
version	string	true	none	The version of the instance.
labels	[string]	false	none	A list of associated labels.
serverId	string	false	none	The identifier of the FVA simulation hub, in case the FVA-Workbench instance is connected via load balancing.
status	string	true	none	The status of the instance.
working	boolean	true	none	Indicates whether the FVA-Workbench instance is currently processing a task.

Enumerated Values

Property	Value
status	PENDING
status	ANALYSING
status	STARTING
status	STOPPING
status	UP
status	DOWN
status	CORRUPT

json

{
  "id": "string",
  "version": "string",
  "labels": [
    "string"
  ],
  "serverId": "string",
  "status": "PENDING",
  "working": true
}

WorkbenchInstancePage

Model containing the properties for a page to respond to the Node-Instance-List endpoint.

Properties

Name	Type	Required	Restrictions	Description
content	[WorkbenchInstance]	true	none	A list of the FVA-Workbench instances of this page.
pageSize	integer(int64)	true	none	The number of maximum items on the page.
pageNumber	integer(int64)	true	none	The current page number.
totalElements	integer(int64)	true	none	The count of all elements.
totalPages	integer(int64)	true	none	The number of all pages considering all elements and the page size.
size	integer(int64)	true	none	The number of items in this page.
first	boolean	true	none	Indicates whether this is the first page of all items.
last	boolean	true	none	Indicates whether this is the last page of all items.

json

{
  "content": [
    {
      "id": "string",
      "version": "string",
      "labels": [],
      "serverId": "string",
      "status": "PENDING",
      "working": true
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}

WorkbenchServer

Model with the properties for Response to the node server endpoint.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The identifier of the FVA Simulation Hub.
version	string	true	none	The version of the FVA Simulation Hub.
baseUrl	string	true	none	The URL to access the FVA simulation hubs.
instances	[WorkbenchInstance]	false	none	A list of related FVA-Workbench instances.
status	string	true	none	The status of the FVA Simulation Hub.

Enumerated Values

Property	Value
status	PENDING
status	UP
status	DOWN
status	OFFLINE

json

{
  "id": "string",
  "version": "string",
  "baseUrl": "string",
  "instances": [
    {
      "id": "string",
      "version": "string",
      "labels": [],
      "serverId": "string",
      "status": "PENDING",
      "working": true
    }
  ],
  "status": "PENDING"
}

WorkbenchServerPage

Model with the properties for a page to respond to the node server list endpoint.

Properties

Name	Type	Required	Restrictions	Description
content	[WorkbenchServer]	true	none	A list of the FVA Simulation Hub instances on this page.
pageSize	integer(int64)	true	none	The number of maximum items on the page.
pageNumber	integer(int64)	true	none	The current page number.
totalElements	integer(int64)	true	none	The count of all elements.
totalPages	integer(int64)	true	none	The number of all pages considering all elements and the page size.
size	integer(int64)	true	none	The number of items in this page.
first	boolean	true	none	Indicates whether this is the first page of all items.
last	boolean	true	none	Indicates whether this is the last page of all items.

json

{
  "content": [
    {
      "id": "string",
      "version": "string",
      "baseUrl": "string",
      "instances": [],
      "status": "PENDING"
    }
  ],
  "pageSize": 0,
  "pageNumber": 0,
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "first": true,
  "last": true
}