Jump to

• Request
• Response
• Examples

Retrieve Details of an XA Transaction

get

/admin/v1/xa-transaction/{id}

Retrieves details of the specified XA transaction ID.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Global transaction ID (GTRID) of the XA transaction. This is a unique ID which you can use to track the transaction.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : xa-transaction

Type: object

Show Source

• begin(required): integer(int64)
  XA transaction begin timestamp
• branches: array branches
• end(required): integer(int64)
  XA transaction end timestamp
• gtrid(required): string
  Global transaction ID (GTRID) of the XA transaction
• hostname(required): string
  TMM coordinator instance id where the XA transaction gets initialized
• status(required): string
  Allowed Values: [ "Created", "Preparing", "Prepared", "Committing", "Committed", "Rollingback", "Rolledback", "MarkedRollback", "HeuristicallyCompleted" ]
• timeout(required): integer(int32)
  XA transaction timeout value in milli seconds
• userId(required): string
  Id of the user who initiated the XA transaction

{
    "type":"object",
    "required":[
        "gtrid",
        "userId",
        "hostname",
        "begin",
        "end",
        "timeout",
        "status"
    ],
    "properties":{
        "gtrid":{
            "type":"string",
            "description":"Global transaction ID (GTRID) of the XA transaction"
        },
        "userId":{
            "type":"string",
            "description":"Id of the user who initiated the XA transaction"
        },
        "hostname":{
            "type":"string",
            "description":"TMM coordinator instance id where the XA transaction gets initialized"
        },
        "begin":{
            "type":"integer",
            "format":"int64",
            "description":"XA transaction begin timestamp"
        },
        "end":{
            "type":"integer",
            "format":"int64",
            "description":"XA transaction end timestamp"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"XA transaction timeout value in milli seconds"
        },
        "status":{
            "$ref":"#/definitions/xa-status"
        },
        "branches":{
            "type":"array",
            "items":{
                "type":"object",
                "description":"XA transaction branches",
                "required":[
                    "branchId",
                    "url",
                    "status"
                ],
                "properties":{
                    "branchId":{
                        "type":"string",
                        "description":"XA transaction branch identifier"
                    },
                    "url":{
                        "type":"string",
                        "description":"XA transaction branch call back url"
                    },
                    "status":{
                        "$ref":"#/definitions/xa-participant-status"
                    }
                }
            }
        }
    }
}

Nested Schema : branches

Type: array

Show Source

• Array of: object items
  XA transaction branches

{
    "type":"array",
    "items":{
        "type":"object",
        "description":"XA transaction branches",
        "required":[
            "branchId",
            "url",
            "status"
        ],
        "properties":{
            "branchId":{
                "type":"string",
                "description":"XA transaction branch identifier"
            },
            "url":{
                "type":"string",
                "description":"XA transaction branch call back url"
            },
            "status":{
                "$ref":"#/definitions/xa-participant-status"
            }
        }
    }
}

Nested Schema : items

Type: object

XA transaction branches

Show Source

• branchId(required): string
  XA transaction branch identifier
• status(required): string
  Allowed Values: [ "Enlisted", "Prepared", "Committed", "Rolledback", "HeuristicallyCompleted", "HeuristicallyRolledback" ]
• url(required): string
  XA transaction branch call back url

{
    "type":"object",
    "description":"XA transaction branches",
    "required":[
        "branchId",
        "url",
        "status"
    ],
    "properties":{
        "branchId":{
            "type":"string",
            "description":"XA transaction branch identifier"
        },
        "url":{
            "type":"string",
            "description":"XA transaction branch call back url"
        },
        "status":{
            "$ref":"#/definitions/xa-participant-status"
        }
    }
}

400 Response

Invalid Arguments

401 Response

Unauthorized

Back to Top

Examples

cURL Command

The following example shows how to view details of an XA transaction by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Authorization:Bearer $OTMM_COOKIE"
     https://192.0.2.1:8080/admin/v1/xa-transaction/e6808684-5d8c-4ad0-90d2-345a225d0f02

• OTMM_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authenticate.

• 192.0.2.1:8080 is an example REST endpoint URL. Change this value to the REST endpoint URL to access the Istio ingress gateway in your environment. For information about finding out REST endpoint URL for your site, see Send Requests.

• e6808684-5d8c-4ad0-90d2-345a225d0f02 is an example value for the global transaction ID (GTRID). Replace this value with the GTRID of an XA transaction in your environment.

Example of the Response Body

The following example shows the contents of the response body in JSON format. Example values have been truncated with ... to improve readability. When you view the response in your environment, you'll see the entire value.

{
  "begin": 1656909341649,
  "encryptedEntry": "Rw/egNz7...",
  "end": 0,
  "gtrid": "e6808684-5d8c-4ad0-90d2-345a225d0f02",
  "hostname": "otmm-tcs-6499...",
  "keyVersion": "1",
  "nonce": "HUnUlVyEhiFjJSU/",
  "status": "Created",
  "thumbprint": "Bearer eyJhb....",
  "timeout": 600000,
  "userId": "43225c1...",
  "branches": [
    {
      "branchId": "otmm-tcs-0-0001",
      "url": "http://dept1:9091/accounts",
      "resourceManagerId": "DEP1-NODE-1D98-479...",
      "status": "Committed",
      "returnCode": "XA_OK",
      "llrBranch": false,
      "encryptedEntry": "",
      "nonce": "",
      "keyVersion": "",
      "thumbprint": ""
    }
  ]
}

Back to Top