Entwicklung kundenspezifischer Client-Anwendungen

GET /api/2.0/auth/login HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "username": "user1", (1)
  "password": "password1" (2)
}

HTTP/1.1 200
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyMiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hcGkvMS4wL2F1dGgvbG9naW4iLCJleHAiOjE2NTEzNDQzMjcsImlhdCI6MTY1MTM0MzcyN30.3gYLlU4wfY53DXd8SMMUA7fxS5gZQhGwW0WD3h3HpeE" (1)
}

GET /actuator/info HTTP/1.1
Host: example.com
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyMiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hcGkvMS4wL2F1dGgvbG9naW4iLCJleHAiOjE2NTEzNDQzMjcsImlhdCI6MTY1MTM0MzcyN30.3gYLlU4wfY53DXd8SMMUA7fxS5gZQhGwW0WD3h3HpeE (1)

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;

public static String encode(Path pathToFile) throws IOException
{
    byte[] fileContent = Files.readAllBytes(pathToFile);
    byte[] contentEncodedBytes = Base64.getEncoder().encode(fileContent);
    return new String(contentEncodedBytes);
}

public static void decode(String base64Content, Path pathToFile) throws IOException
{
    byte[] content = Base64.getDecoder().decode(base64Content);
    Files.write(pathToFile, content);
}

POST /api/2.0/workbench/task/simulate-work/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "duration": 10 (1)
}

HTTP/1.1 201
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "WAITING",
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3", (1)
  "requestedDatetime": "2022-03-30T13:20:48.940547"
}

GET /api/2.0/workbench/task/simulate-work/b431a18d-8e92-46d9-a9a5-b456dbc898e3/result HTTP/1.1 (1)
Host: example.com

GET /api/2.0/workbench/task/simulate-work/b431a18d-8e92-46d9-a9a5-b456dbc898e3/result?timeout=60 HTTP/1.1 (1)
Host: example.com

HTTP/1.1 201
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "RUNNING", (1)
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3",
  "requestedDatetime": "2022-03-30T13:20:48.940547", (2)
  "startedDatetime": "2022-03-30T13:25:48.4796426" (3)
}

HTTP/1.1 200
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "FINISHED", (1)
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3",
  "executingWorkbench": (2)
  {
    "id": "foo",
    "version": "7.1.0",
    "revision": "12345"
  },
  "requestedDatetime": "2022-03-30T13:20:48.940547",
  "startedDatetime": "2022-03-30T13:25:48.4796426",
  "endedDatetime": "2022-03-30T13:25:58.6424796", (3)
  "message": "received Workbench after 0 seconds, then waited for 10 seconds" (4)
}

{
  "inputModel":
  {
    "type": "WBPZ", (1)
    "content": "UEsDBAoAAAAAAMNwGFUAAAAAAAAAA..." (2)
  },
  "inputScripts": [
    {
      "content": "cnVuQ2FsY01ldGhvZCgnMDAxX1NZU1RFTV9DQUxDVUxBVElPTicsIDEpOw==" (3)
    }
  ],
  "additionalFiles": [ (4)
    {
      "filename": "some-file.txt",
      "content": "cnVuQ2FsY01ldGhvZCgnMDAxX1NZU1RFTV9DQUxDVUxBVElPTicsIDEpOw=="
    }
  ]
}

HTTP/1.1 201
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "WAITING",
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3",
  "requestedDatetime": "2022-03-30T13:20:48.940547"
}

const status = runCalcMethod('001_SYSTEM_CALCULATION', 1); (1)
if (status === 1) { (2)
    println('Calculation was successful');
    const templateFile = WorkingDirectory + '/000_System_report.wbrep'; (3)
    const outputFile = OutputDirectory + '/report.html'; (4)
    const options = {compactView: false,
                        language: "de",
                        completeTree: false,
                        notifications: true,
                        navigationBar: true};
    generateReport(templateFile, outputFile, options); (5)
    exportModel(OutputDirectory + '/test.rexs'); (6)
} else {
    exportNotifications(OutputDirectory + '/notifications.xml'); (7)
    throw 'Calculation was NOT successful'; (8)
}

GET /api/2.0/workbench/task/execute-batch-job/b431a18d-8e92-46d9-a9a5-b456dbc898e3/result?timeout=60 HTTP/1.1 (1)
Host: example.com

HTTP/1.1 200
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "FINISHED", (1)
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3",
  "batchExecutionStatus": "OK", (2)
  "executingWorkbench": (3)
  {
    "id": "foo",
    "version": "7.1.0",
    "revision": "12345"
  },
  "requestedDatetime": "2022-03-30T13:20:48.940547", (4)
  "startedDatetime": "2022-03-30T13:25:48.4796426", (5)
  "endedDatetime": "2022-03-30T13:26:25.6424796", (6)
  "outputFiles": [ (7)
    {
      "directory": "path/to/file/in/output/directory",
      "filename": "protocol.log",
      "content": "UEsDBAoAAAAAAKlbVlIAAAAAAAAAAAAAAAALACQAcmVzdW..."
    }
  ]
}

GET /api/2.0/storage/input/upload?overwrite=true HTTP/1.1
Host: example.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="cylindrical-gear_model.wbpz"

... contents of file goes here ...
------WebKitFormBoundary7MA4YWxkTrZu0gW--

HTTP/1.1 204
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

import java.io.IOException;
import java.net.URI;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;

import org.springframework.core.io.FileSystemResource;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;

import de.fva.simulationhub.api.workbench.task.ExecuteBatchJobRequest.WorkbenchModelTypeEnum;

public class Application
{
    public static void main(String[] args)
    {
        RestTemplate restTemplate = new RestTemplate();

        // Headers
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.MULTIPART_FORM_DATA);

        // Body
        MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
        Path pathToFile = Paths.get("path/to/cylindrical-gear_model.wbpz");
        body.add("file", new FileSystemResource(pathToFile)); (1)

        HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers);

        // URL
        String url = "http://localhost:8080/api/2.0/storage/input/upload";

        // Query parameters
        UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(url)
            .queryParam("overwrite", true);

        URI uri = builder.build().toUri();

        // Submit request
        ResponseEntity<Void> response = restTemplate.postForEntity(uri, requestEntity, Void.class);
        System.out.println("Response code: " + response.getStatusCode());
    }
}

{
  "inputModel": {
    "type": "WBPZ",
    "storageName": "cylindrical-gear_model.wbpz" (1)
  },
  "inputScripts": [
    {
      "content": "cnVuQ2FsY01ldGhvZCgnMDAxX1NZU1RFTV9DQUxDVUxBVElPTicsIDEpOw=="
    }
  ]
}

HTTP/1.1 201
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "status": "WAITING",
  "id": "b431a18d-8e92-46d9-a9a5-b456dbc898e3",
  "requestedDatetime": "2022-03-30T13:20:48.940547"
}

GET /api/2.0/storage/input/cylindrical-gear_model.wbpz HTTP/1.1 (1)
Host: example.com

HTTP/1.1 200
Content-Type: application/json
Date: Mon, 02 May 2022 12:26:00 GMT

{
  "exists": true
}