Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

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.

Preconditions

As of today, only JPA is implemented.

Tia-Core needs a configured protocol section. See : JpaProtocolService

Usage:

The Protocol Reader Service exposes following REST-Endpoints:

Endpoints

GET

   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 :

Coming Soon:

OpenAPI Definition / Swagger

  • No labels