Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Architecure:

/wiki/spaces/DEV/pages/2705522696

Introduction

The Protocol Reader Service starts automatically in the tia Core: SAPHTTP, CMIS and ILM. It enables a client to connect to the Application via REST and receive ProtocolEntries that were stored previously by the ProtocolService. It starts automatically in the tia Core for all protocols (SAPHTTP, CMIS and ILM).

Preconditions

As of today, only JPA is implementedProtocol Reader Service is only available for database.

Tia-Core needs a configured protocol section. See : JpaProtocolService Protocol Database (tC)

Usage:

The Protocol Reader Service exposes following REST-Endpoints:

...

Code Block
   http://<Server>:<port>/protocolreader/records?repository=<String repoName>&requestId=<String RequestId>
   http://<Server>:<port>/protocolreader/records?repository=<String repoName>&startTime=<ISO startTime>&endTime=<ISO endTime>&offset=<int offset>&pageSize=<int pageSize>
   http://<Server>:<port>/protocolreader/records?repository=<String repoName>&startTime=<ISO startTime>&endTime=<ISO endTime>&offset=<int offset>&pageSize=<int pageSize>&commandStatus=[String commandStatus]

Allowed Parameters:

Parametername

Type

Value Sample

repository

String

FI

requestId

String

35c91fb2-8eed-4237-8cab-27b50070b6a1

startTime

ISO with TimeZone

2023-06-14T12:28:22.000Z

endTime

ISO with TimeZone

2023-06-14T12:29:30.123Z

commandStatus

String

One of:

  • error

  • success

Postman-Collection :

View file
nameKGS tia Core.postman_collection.json

...