Versions Compared

Old Version 2

changes.mady.by.user Petr Jůza

Saved on

compared with

New Version 3

changes.mady.by.user Former user

Saved on

Key

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

...

TraceIndentifier parameters

ParameterTypeDescriptionMandatory
applicationIDstringIdentification of source application.Y
timestampdateTimeTimestamp of sent request.Y
correlationIDstring

Used to track calls from the service consumer to the API.
This parameter is free text, unique value (e.g. UUID), generated by the caller.
It is the responsibility of the application to generate a unique value and pass it during each call to the API.
Unique identifier (at least for specific application) serves for pairing asynchronous request/response messages.

Y
processIDstring

Used to track calls connected to one process (e.g. one process is "creating new customer" and it means calling creating customer, then activating him etc.)

This parameter is free text, unique value (e.g. UUID), generated by the caller.
It is the responsibility of the application to generate a unique value and pass it to all calls of one process.

N

 

SOAP example:

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://openhubframework.org/ws/Common-v1" xmlns:hel="http://openhubframework.org/ws/HelloService-v1">
   <soapenv:Header>
      <com:traceHeader>
         <com:traceIdentifier>
            <com:applicationID>APPL001</com:applicationID>
            <com:timestamp>2013-05-21T10:33:58.147+02:00</com:timestamp>
            <com:correlationID>${=java.util.UUID.randomUUID()}</com:correlationID>
            <!--Optional:-->
            <com:processID>process001</com:processID>
         </com:traceIdentifier>
      </com:traceHeader>
   </soapenv:Header>
   <soapenv:Body>
      <hel:asyncHelloRequest>
         <hel:name>CleverBusname>OpenHub team</hel:name>
      </hel:asyncHelloRequest>
   </soapenv:Body>
</soapenv:Envelope>

...