GET /api/apis/versions/{APIVersionID}/txlogs/{TransactionID}

Returns information about a specific transaction for an API version.

For additional information regarding the set of operations dealing with metric information, see Metrics on the Platform.

Authorization Roles/Permissions: Must be logged in. Must be a user with Monitor permission for the API; an API Admin or Business Admin or an app developer who has a contract with the API.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/txlogs/{TransactionID}

Back to top

Sample Request

The example below shows a request for a specific transaction record for a specific API.

Request URL

https://{hostname}/api/apis/versions/apiversion400.acmepaymentscorp/txlogs/5e38b76e-b8b6-11e2-985a-a81e

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, text/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
TransactionID Path string Required The unique ID for a specific transaction.
TimeZone Query string Optional The time zone for the information. If a time zone isn't specified, the information is returned in GMT. For more information, refer to Working with Time Zones and Time Intervals.
IncludeMessageContents Query boolean Optional To include the transaction message contents in the response, set to true. Default: false (message contents are not included).

Back to top

Response

If successful, this operation returns HTTP status code 200, with the transaction information in the requested format.

Back to top

Sample Response

The sample response below shows details of a specific API transaction.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 09 May 2013 15:48:47 GMT

Sample response body: application/json

{
  "TransactionID" : "5e38b76e-b8b6-11e2-985a-a81e78f0181a",
  "APIID" : "api100.acmepaymentscorp",
  "APIName" : "LoginAPI Service",
  "APIVersionID" : "apiversion400.acmepaymentscorp",
  "MethodName" : "getLoginDomains",
  "RequestDateTime" : "2013-05-09T14:40:17.887Z",
  "ResponseStatusCode" : 0,
  "ClientHost" : "0.0.0.0",
  "APIVersionName" : "1.0",
  "ResponseTime" : "P0Y0M0DT0H0M0.022S",
  "RequestMessageSize" : 0,
  "ResponseMessageSize" : 224,
  "APIResponseTime" : "P0Y0M0DT0H0M0.000S",
  "APIURL" : "https://{hostname}/api/login/domains",
  "RequestMessage" : {
    "Message" : "EMPTY MESSAGE",
    "TransportHeaders" : "GET /api/login/domains?_=1368110417837 HTTP/1.1\nHost: {hostname}\nUser-Agent: 
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0\nAccept: application/json,text/javascript,*/*;q=0.01\n
Accept-Language: en-US,en;q=0.5\nAccept-Encoding: gzip, deflate\nCookie: __utma=120274954.1033981115.1360618092.136
7978778.1368109070.82; __utmz=120274954.1360695664.4.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none); __utmc=120274954; __
utmb=120274954.9.10.1368109070; JSESSIONID_pm60=1ou8r2dy4j7p1; AtmoAuthToken_acmepaymentscorp=TokenID%3Dd88eba49-b8b5-11e2-985a-a81e7
8f0181a%2Cclaimed_id%3Durn%3Aacme%3Auser%open%3Auser10002%2CissueTime%3D1368110193668%2CexpirationTime%3D13681119936
36%2CAttributesIncluded%3Dfalse%2CUserFDN%3Duser10002%open%2CUserName%3Daopen%2Csig%3DGQIPSVgVrKf_5zhlJ_zsqlSwWVaY3z0MVFz_t
rMBwRnoa51hGWbZlzXzxPCFrUbhDrl1zZmlytdCh3CfOiOHms9Ry4duim7Q9k97ruhss5-ncJ-wT2KXcLVPuagWdVPuZrzF0mpy-L5PUT1V-LOy3QpIjfWiZJZs
TdNnSeKUMtE; AtmoAuthToken_mytenant=TokenID%3Dd8991b3c-b8b5-11e2-81b9-f5950bd2d239%2Cclaimed_id%3Durn%3Aacme%3Ause
r%3Aacmepaymentscorp%3Auser10002%2CissueTime%3D1368110193739%2CexpirationTime%3D1368111993704%2CAttributesIncluded%3Dfalse%2CUserFDN%3D
user10002%252Eopen%2CUserName%3Dopen%2Csig%3DNoZbjkCblMuafFXGKlshF6t886SC1K9bl7XDStKBxkAaUNaHzUe3XaE1uwYnG2lL0_4Krk_scR3Mu
6_ps4AqAYAsVVZuoRDfFwj5n3vVQrCys4f8cTr92HRWE9fU0HmZeNrL78sfJXeiC6lla8RMC4YE4yUVaZJAXOwXEZW_RWg\nConnection: keep-alive\
nReferer: https://api.acmepaymentscorp.com/acme/\nX-Requested-With: XMLHttpRequest\n"
  },
  "ResponseMessage" : {
    "Message" : "[ {\n  \"LoginDomainID\" : \"siteusers.acmepaymentscorp\",\n  \"FedmemberId\" : \"open\",\n  \"Title\" : \"acmepaymentscorp-users\",
\n  \"Sequence\" : -1,\n  \"VirtualHost\" : [ ],\n  \"IdSystemType\" : \"Policy Manager\",\n  \"LogoAssigned\" : false,
\n  \"Enabled\" : true\n} ]",
    "TransportHeaders" : "Content-Encoding: gzip\nDate: Thu, 09 May 2013 14:40:17 GMT\nContent-Type: application/json
\nTransfer-Encoding: chunked\n"
  }
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: text/xml
Date: Thu, 09 May 2013 15:33:35 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<TransactionRecord xmlns:ns2="http://soa.com/xsd/performance/1.0">
    <ns2:TransactionID>5e38b76e-b8b6-11e2-985a-a81e78f0181a</ns2:TransactionID>
    <ns2:APIID>api100.acmepaymentscorp</ns2:APIID>
    <ns2:APIName>LoginAPI Service</ns2:APIName>
    <ns2:APIVersionID>apiversion400.acmepaymentscorp</ns2:APIVersionID>
    <ns2:MethodName>getLoginDomains</ns2:MethodName>
    <ns2:RequestDateTime>2013-05-09T14:40:17.887Z</ns2:RequestDateTime>
    <ns2:ResponseStatusCode>0</ns2:ResponseStatusCode>
    <ns2:ClientHost>0.0.0.0</ns2:ClientHost>
    <ns2:APIVersionName>1.0</ns2:APIVersionName>
    <ns2:ResponseTime>P0Y0M0DT0H0M0.022S</ns2:ResponseTime>
    <ns2:RequestMessageSize>0</ns2:RequestMessageSize>
    <ns2:ResponseMessageSize>224</ns2:ResponseMessageSize>
    <ns2:APIResponseTime>P0Y0M0DT0H0M0.000S</ns2:APIResponseTime>
    <ns2:APIURL>https://{hostname}/api/login/domains</ns2:APIURL>
    <ns2:RequestMessage>
        <ns2:Message>EMPTY MESSAGE</ns2:Message>
        <ns2:TransportHeaders>GET /api/login/domains?_=1368110417837 HTTP/1.1 Host: {hostname} 
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
Accept: application/json,text/javascript,*/*;q=0.01 Accept-Language: en-US,en;q=0.5 Accept-Encoding: gzip, 
deflate Cookie: __utma=120274954.1033981115.1360618092.1367978778.1368109070.82; __utmz=120274954.1360695664.4.1.utmcsr=
(direct)|utmccn=(direct)|utmcmd=(none); __utmc=120274954; __utmb=120274954.9.10.1368109070; JSESSIONID_pm60=1ou8r2dy4j7p1; 
AtmoAuthToken_acmepaymentscorp=TokenID%3Dd88eba49-b8b5-11e2-985a-a81e78f0181a%2Cclaimed_id%3Durn%3Aacme%3Auser%3Aacmepaymentscorp%3Auser10002
%2CissueTime%3D1368110193668%2CexpirationTime%3D1368111993636%2CAttributesIncluded%3Dfalse%2CUserFDN%3Duser10002%252Eopen%2
CUserName%3Dopen%2Csig%3DGQIPSVgVrKf_5zhlJ_zsqlSwWVaY3z0MVFz_trMBwRnoa51hGWbZlzXzxPCFrUbhDrl1zZmlytdCh3CfOiOHms9Ry4duim7Q9k
97ruhss5-ncJ-wT2KXcLVPuagWdVPuZrzF0mpy-L5PUT1V-LOy3QpIjfWiZJZsTdNnSeKUMtE; AtmoAuthToken_mytenant=TokenID%3Dd8991b3c-b8b
5-11e2-81b9-f5950bd2d239%2Cclaimed_id%3Durn%3Aacme%3Auser%3Aacmepaymentscorp%3Auser10002%2CissueTime%3D1368110193739%2Cexpiration
Time%3D1368111993704%2CAttributesIncluded%3Dfalse%2CUserFDN%3Duser10002%252Eopen%2CUserName%3Dopen%2Csig%3DNoZbjkCblMuafFX
GKlshF6t886SC1K9bl7XDStKBxkAaUNaHzUe3XaE1uwYnG2lL0_4Krk_scR3Mu6_ps4AqAYAsVVZuoRDfFwj5n3vVQrCys4f8cTr92HRWE9fU0HmZeNrL78sfJ
XeiC6lla8RMC4YE4yUVaZJAXOwXEZW_RWg
Connection: keep-alive Referer: https://api.acmepaymentscorp.com/acme/ X-Requested-With: XMLHttpRequest
</ns2:TransportHeaders>
    </ns2:RequestMessage>
    <ns2:ResponseMessage>
        <ns2:Message>[ {
  "LoginDomainID" : "siteusers.acmepaymentscorp",
  "FedmemberId" : "open",
  "Title" : "acmepaymentscorp-users",
  "Sequence" : -1,
  "VirtualHost" : [ ],
  "IdSystemType" : "Policy Manager",
  "LogoAssigned" : false,
  "Enabled" : true
} ]</ns2:Message>
        <ns2:TransportHeaders>Content-Encoding: gzip
Date: Thu, 09 May 2013 14:40:17 GMT
Content-Type: application/json
Transfer-Encoding: chunked
</ns2:TransportHeaders>
    </ns2:ResponseMessage>
</TransactionRecord>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, text/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
TransactionRecord TransactionRecord Contains detailed information about a transaction for an app or API.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you hadn't completed login before running the operation.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics