Versions Compared

Old Version 1

changes.mady.by.user Armin Franke

Saved on

compared with

New Version Current

changes.mady.by.user Armin Franke

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The protocol reader API can be accessed using a swagger UI. The Swagger UI displays information about the API definition and allows to quickly test the API mith with manual input.

For more information about Swagger UI, please see external link: https://swagger.io/tools/swagger-ui/

...

Info

Note: The Authorization header is not included in the curl-command. When using it from terminal, use -u parameter to add credentials.

Example:

  • Code Block
    curl -X 'GET' \
'http://<tia host>:<port>/protocolreader/records/?repository=CE&offset=0&pageSize=5&startTime=2023-06-14T12%3A03%3A09.774Z&endTime=2023-06-14T12%3A05%3A09.774Z&commandStatus=success' \
-H 'accept: application/json' \
-H 'X-TiaClientId: MyCompany' \
-u 'admin:15cB5aKTb(Ousk7q'
Info

Note: The Swagger UI is running in the container and creating requests with the internal port (that is 8080). If at deployment time of the tia container the port 8080 was not mapped to the host port 8080, the request created by Swagger UI will not automatically execute.The request can be copied from Swagger UI into browser address bar and the

port 8080 can be replaced by the host port in order to get the request executedWhen copying the curl-command, edit the port number to execute the request successfully.