GET /api/apps/versions/{AppVersionID}/txlogs/{TransactionID}

Returns information about a specific transaction for an app 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 have monitor permission for the app; an App team member, Business Admin, or API Admin for an API that the app has a contract with.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/txlogs/{TransactionID}

Back to top

Sample Request

The example below shows a response for this operation.

Sample request URL

https://{hostname}/api/apps/versions/7FuucUjB7B3AYcUVvQpEVv1B.acmepaymentscorp/txlogs/54ee77d8-c659-11e3-829c-9e428460984d

Sample request headers

GET /api/apps/versions/7FuucUjB7B3AYcUVvQpEVv1B.acmepaymentscorp/txlogs/54ee77d8-c659-11e3-829c-9e428460984d HTTP/1.1
Accept: application/json, text/javascript, */*; q=0.01
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
AppVersionID Path string Required The unique ID for a specific app 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 transaction details for a specific transaction.

Sample response headers

HTTP/1.1 200 OK
Content-Type:  application/vnd.soa.v80+json
Cache-Control: no-cache
Date: Tue, 05 Jan 2016 21:55:31 GMT

Sample response body

{
  "TransactionID" : "dfb89212-b3f6-11e5-950c-e486a13080bf",
  "APIID" : "de4b8ee5-e650-4166-a627-becf99f2d282.acmepaymentscorp",
  "APIName" : "SwaggerAPI_Both",
  "APIVersionID" : "7f37e4ac-0e7e-4826-9103-e2deef13f754.acmepaymentscorp",
  "MethodName" : "addPet",
  "AppID" : "93213f5b-7d6b-486a-b69c-28e0531559bd.acmepaymentscorp",
  "AppName" : "__SwaggerApp_prod",
  "AppVersionID" : "ZgzIfKEG39336phtnW82m3Eo.acmepaymentscorp",
  "RequestDateTime" : "2016-01-05T21:54:20Z",
  "ResponseStatusCode" : 200,
  "ClientHost" : "10.1.22.242",
  "APIVersionName" : "1.0",
  "MethodKey" : "dfb89212-b3f6-11e5-950c-e486a13080bf",
  "AppVersionName" : "1.0",
  "AppRuntimeID" : "ZgzIfKEG39336phtnW82m3Eo",
  "ResponseTime" : "P0Y0M0DT0H0M0.170S",
  "RequestMessageSize" : 209,
  "ResponseMessageSize" : 155,
  "HttpVerb" : "POST",
  "RequestMessage" : {
    "Message" : "{\n  \"category\": {\n    \"id\": 0,\n    \"name\": \"string\"\n  },\n 
 \"name\": \"Riley the Rottie\",\n  \"photoUrls\": [\n    \"string\"\n  ],\n  \"tags\": [\n
    {\n      \"id\": 0,\n      \"name\": \"string\"\n    }\n  ],\n  \"status\": \"sold\"\n}",
    "TransportHeaders" : "POST /prod/pet HTTP/1.1\nAtmo-Forward-To: http://acmepaymentscorp.com/prod/pet\nAccept: */*\n
Connection: keep-alive\nReferer: http://acmepaymentscorp.com/acmepaymentscorp/\nAccept-Encoding: gzip, deflate\n
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0\n
Content-Type: application/json; charset=UTF-8\nAccept-Language: en-US,en;q=0.5\n
Atmo-Forwarded-From: http://acmepaymentscorp.com/forwardproxy/1452030860014\n
Cookie: _ga=GA1.2.1433997936.1445457936; _mkto_trk=id:629-REV-740&token:_mch-acmepaymentscorp.com-1445457936556-81858; 
__ar_v4=DV6Z3DM2IVAT5P6URKK3RO%3A20151124%3A3%7CWORRISBFGNASNPUS72EOCQ%3A20151124%3A3%7CRPR2NZZ7AJBC3PYDEVVTCG%3A20151
124%3A3; JSESSIONID_pm80=ri7258kp82b9rbopet5ehi24; AtmoAuthToken_acmepaymentscorp=TokenID%3D6bd4256f-b3f6-11e5-91cf-9b
60fe8e503a%2Cclaimed_id%3Durn%3Aacmepaymentscorp%3Auser%3Aacmepaymentscorp%3Aa9a7ec37-06e9-4fcd-8d40-a56fa98904ea
%2CissueTime%3D1452030665755%2CexpirationTime%3D1452032165705%2CUserName%3Dadminacmepaymentscorp%2CUserFDN%3Da9a7ec3
7-06e9-4fcd-8d40-a56fa98904ea%252Eacmepaymentscorp%2CAttributesIncluded%3Dfalse%2Csig%3DPW1UObCOHrIQlPa9V7PHc9IK1Ljel
M6-9SVQJqEnZdIfyNWWToGoJy1V_mw8hpvBCHVehanqK_3r_iRQ7u-kGWaD-dDerM3-m9JkbQToohCYISytzrlp0yV5bxFqqEFwWIyal7nz5PMD5blBe
IHYPAT53cSY1OVJpB6Ui338afs; oauthRedirectInfoCookie=%7B%22accessTokenUrl%22%3A%22%2Fapi%2Fdevconsole%2Foauth%2F
accesstoken%22%2C%22providerEndpoint%22%3A%22%2Fapi%2Fdevconsole%2Foauth%2Faccesstoken%22%2C%22queryString%22%3A%22
session_key%3Dtoken_verb%253DPOST%2526opname%253DgetPetById%2526Subject%253Dacmepaymentscorp%2526granttype%253D
authorization_code%2526apiv%253D7f37e4ac-0e7e-4826-9103-e2deef13f754.acmepaymentscorp%2526auz_url%253Dhttp%253A%2
52F%252Facmepaymentscorp.com%252Foauth%252Fauz%252Fauthorize%2526Type%253DOAuth%2525202.0%2526policy_key%253Do
auth%2526policy_type%253DOAuth%2525202.0%2526apienv%253DProduction%2526SessionKey%253D%2526scope%253DScope1%2526
appid%253Dacmepaymentscorp-ZgzIfKEG39336phtnW82m3Eo%2526guid%253D5216147d-c799-47f1-b20b-95261e61a394%2526
callback%253Dhttp%253A%252F%252F ..."
  },
  "ResponseMessage" : {
    "Message" : "{\"id\":1452026428320,\"category\":{\"id\":0,\"name\":\"string\"},\"name\":\"Riley the Rottie\",
\"photoUrls\":[\"string\"],\"tags\":[{\"id\":0,\"name\":\"string\"}],\"status\":\"sold\"}",
    "TransportHeaders" : "HTTP/1.1 200\nAccess-Control-Allow-Origin: *\nAccess-Control-Allow-Headers: 
Content-Type, api_key, Authorization\nContent-Encoding: gzip\nDate: Tue, 05 Jan 2016 21:54:20 GMT\n
Content-Type: application/json\nTransfer-Encoding: chunked\nAccess-Control-Allow-Methods: GET, POST, DELETE, PUT\n
Server: Jetty(7.6.10.v20130312)\n"
  },
  "Messages" : {
    "Message" : [ {
      "MessageName" : "APPLICATION",
      "MessageCapturedTime" : "2016-01-05T13:54:20-08:00",
      "TransportHeaders" : "POST /prod/pet HTTP/1.1\nAtmo-Forward-To: http://acmepaymentscorp.com/prod/pet\n
Accept: */*\nConnection: keep-alive\nReferer: http://acmepaymentscorp.com/acmepaymentscorp/\n
Accept-Encoding: gzip, deflate\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0\n
Content-Type: application/json; charset=UTF-8\nAccept-Language: en-US,en;q=0.5\n
Atmo-Forwarded-From: http://acmepaymentscorp.com/forwardproxy/1452030860014\n
Cookie: _ga=GA1.2.1433997936.1445457936; _mkto_trk=id:629-REV-740&token:_mch-acmepaymentscorp.com-1445457936556-81858; 
__ar_v4=DV6Z3DM2IVAT5P6URKK3RO%3A20151124%3A3%7CWORRISBFGNASNPUS72EOCQ%3A20151124%3A3%7CRPR2NZZ7AJBC3PYDEVVTCG%3A2015
1124%3A3; JSESSIONID_pm80=ri7258kp82b9rbopet5ehi24; AtmoAuthToken_acmepaymentscorp=TokenID%3D6bd4256f-b3f6-11e5-91cf-9
b60fe8e503a%2Cclaimed_id%3Durn%3Aacmepaymentscorp%3Auser%3Aacmepaymentscorp%3Aa9a7ec37-06e9-4fcd-8d40-a56fa98904ea%2C
issueTime%3D1452030665755%2CexpirationTime%3D1452032165705%2CUserName%3Dadminacmepaymentscorp%2CUserFDN%3Da9
a7ec37-06e9-4fcd-8d40-a56fa98904ea%252Eacmepaymentscorp%2CAttributesIncluded%3Dfalse%2Csig%3DPW1UObCOHrIQlPa9V7PHc
9IK1LjelM6-9SVQJqEnZdIfyNWWToGoJy1V_mw8hpvBCHVehanqK_3r_iRQ7u-kGWaD-dDerM3-m9JkbQToohCYISytzrlp0yV5bxFqqEFwWIyal7nz
5PMD5blBeIHYPAT53cSY1OVJpB6Ui338afs; oauthRedirectInfoCookie=%7B%22accessTokenUrl%22%3A%22%2Fapi%2Fdevconsole%2F
oauth%2Faccesstoken%22%2C%22providerEndpoint%22%3A%22%2Fapi%2Fdevconsole%2Foauth%2Faccesstoken%22%2C%22
queryString%22%3A%22session_key%3Dtoken_verb%253DPOST%2526opname%253DgetPetById%2526Subject%253D
acmepaymentscorp%2526granttype%253Dauthorization_code%2526apiv%253D7f37e4ac-0e7e-4826-9103-e2deef13f754.acmepaymentscorp
%2526auz_url%253Dhttp%253A%252F%252Fwww.acmepaymentscorp.com%252Foauth%252Fauz%252Fauthorize%2526
Type%253DOAuth%2525202.0%2526policy_key%253Doauth%2526policy_type%253DOAuth%2525202.0%2526apienv%253DProduction%2526
SessionKey%253D%2526scope%253DScope1%2526appid%253Dacmepaymentscorp-ZgzIfKEG39336phtnW82m3Eo%2526guid%253D5216147
d-c799-47f1-b20b-95261e61a394%2526callback%253Dhttp%253A%252F%252F ...",
      "MessageBody" : "{\n  \"category\": {\n    \"id\": 0,\n    \"name\": \"string\"\n  },\n  \"name\": 
\"Riley the Rottie\",\n  \"photoUrls\": [\n    \"string\"\n  ],\n  \"tags\": [\n    {\n      \"id\": 0,\n
      \"name\": \"string\"\n    }\n  ],\n  \"status\": \"sold\"\n}",
      "Category" : [ "APPLICATION", "request", "complete" ]
    }, {
      "MessageName" : "APPLICATION",
      "MessageCapturedTime" : "2016-01-05T13:54:20-08:00",
      "TransportHeaders" : "HTTP/1.1 200\nAccess-Control-Allow-Origin: *\nAccess-Control-Allow-Headers: 
Content-Type, api_key, Authorization\nContent-Encoding: gzip\nDate: Tue, 05 Jan 2016 21:54:20 GMT\n
Content-Type: application/json\nTransfer-Encoding: chunked\nAccess-Control-Allow-Methods: GET, POST, DELETE, PUT\n
Server: Jetty(7.6.10.v20130312)\n",
      "MessageBody" : "{\"id\":1452026428320,\"category\":{\"id\":0,\"name\":\"string\"},\"name\":\"Riley the Rottie\",
\"photoUrls\":[\"string\"],\"tags\":[{\"id\":0,\"name\":\"string\"}],\"status\":\"sold\"}",
      "Category" : [ "APPLICATION", "response", "complete" ]
    } ]
  }
}

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 didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.

You would also 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