GET /ops/{protocol}/{correlationID}/{legID}/getinfo

Description

Retrieves information about events associated with the specified correlationID and legID

If no results are found (in a case where no inbound transaction was received) an empty transaction object will be returned within the JSON response.

---

Message from/to client

To Track a transaction received from a client (and the response returned to that client) invoke the request with legID set to 0, as follows:

http://localhost:8090/ops/any/a18ce3874de8a62712176c6c/0/getinfo?format=json&details=1&rheaders=1&sheaders=1

---

Message from/to target service

To track a transaction sent from the API Server to a target service (and the response returned to the API Server) invoke the request with legID > 0, or * to obtain all transactions associated with a correlationID for a message.

http://localhost:8090/ops/any/a18ce3874de8a62712176c6c/1/getinfo?format=json&details=1&rheaders=1&sheaders=1

---

Resource URL

http://localhost:8090/ops/{protocol}/{correlationID}/{legID}/getinfo

---

Parameters

protocol	mandatory	The protocol/opevent type associated with the specified correlationID/leg. The use of this field is historic, and it can be hardcoded to "any", or set to a known opevent type (eg, http, filetransfer, dirscan, etc)
correlationID	mandatory	Transaction Identifier. E.g.: a18ce3874de8a62712176c6c
legID	mandatory	Leg number or * for all legs. Leg 0 represents transaction received from the client. Legs > 0 represent transactions sent from the API Server.
format	mandatory	Specifies the format of the response. Currently json is the only supported format.
details	optional	Specifies whether or not opevent-related details are returned in the response ( as per the results of the (search)[./search.html] operation. ) Possible values: 1 (i.e. details returned), or 0 (details = null returned)
rheaders	optional	(HTTP only) Specifies whether or not received HTTP headers are returned in the response.
sheaders	optional	(HTTP only) Specifies whether or not transmitted HTTP headers will be returned in the response.

---

Response Codes

Response Code	Description
200	Success

---

Example Transaction

Request

GET /api/router/service/instance-1/ops/http/d91cbd530200000000000000681193bd/0/getinfo?sheaders=1&rheaders=1&details=1&format=json HTTP/1.0
Connection: close
Host: localhost
Authorization:  Basic YWRtaW46Y2hhbmdlbWU=

Response

HTTP/1.1 200 OK
Server: Gateway
Connection: close
X-CorrelationID: Id-9f64bd537704000000000000a99ccf25 0
Date: Wed, 09 Jul 2014 15:49:51 GMT
Date: Wed, 09 Jul 2014 15:49:51 GMT
Expires: Wed, 09 Jul 2014 15:49:51 GMT
Server: Gateway
Content-Type: application/json

{
    "sheaders": [
    {
        "Date": "Wed, 09 Jul 2014 10:43:37 GMT"
    },
    {
        "Server": "Gateway"
    },
    {
        "Connection": "close"
    },
    {
        "X-CorrelationID": "Id-d91cbd530200000000000000681193bd 0"
    },
    {
        "Host": "localhost"
    },
    {
        "Content-Type": "text/xml"
    }
    ],
    "rheaders": [
    {
        "Connection": "close"
    },
    {
        "Host": "localhost"
    }
    ],
    "details": {
    "uri": "/healthcheck",
    "status": 200,
    "statustext": "OK",
    "method": "GET",
    "vhost": null,
    "bytesSent": 208,
    "bytesReceived": 65,
    "remoteName": "127.0.0.1",
    "remoteAddr": "127.0.0.1",
    "localAddr": "127.0.0.1",
    "remotePort": "51225",
    "localPort": "8080",
    "sslsubject": null,
    "leg": 0,
    "timestamp": 1404902617764,
    "duration": 53,
    "correlationId": "d91cbd530200000000000000681193bd",
    "serviceName": null,
    "subject": null,
    "operation": null,
    "type": "http",
    "finalStatus": "Pass"
    }
}