REST API for Oracle Transaction Manager for Microservices

Retrieve Details of all TCC Transactions

get

/admin/v1/tcc-transaction

Retrieves details of all the TCC transactions that are processed by Transaction Manager for Microservices and which match the specified transaction status. If you don't specify any query parameters, then details of all the current TCC transactions are retrieved.

Request

Supported Media Types

application/json

Query Parameters

begin: integer(int32)

Specify the offset or the number of records that you want to skip viewing. For example, enter 100 to view information from the 100th record and beyond. When there are a large number of records, the number of returned responses that is displayed is limited and {{more }} is set to {{true }} to indicate that more records are available for you to view. If {{more }} is set to {{false }}, then all the records have been displayed
status: string

transaction status

Allowed Values: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: object tcc-transactions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/tcc-transactions"
    }
}

Nested Schema : tcc-transactions

Type: object

Show Source

more: boolean
transactions: array transactions

{
    "type":"object",
    "properties":{
        "more":{
            "type":"boolean"
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/tcc-transaction"
            }
        }
    }
}

Nested Schema : transactions

Type: array

Show Source

Array of: object tcc-transaction

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/tcc-transaction"
    }
}

Nested Schema : tcc-transaction

Type: object

Show Source

hostname(required): string

ID of the MicroTx coordinator instance where the TCC transaction began.
id(required): string

Unique transaction ID of the TCC transaction.
participants: array participants
startTime(required): string

The time at which the TCC transaction began.
status(required): string

Allowed Values: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]
userId(required): string

ID of the user who initiated the TCC transaction.

{
    "type":"object",
    "required":[
        "id",
        "userId",
        "hostname",
        "status",
        "startTime"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique transaction ID of the TCC transaction."
        },
        "userId":{
            "type":"string",
            "description":"ID of the user who initiated the TCC transaction."
        },
        "hostname":{
            "type":"string",
            "description":"ID of the MicroTx coordinator instance where the TCC transaction began."
        },
        "status":{
            "$ref":"#/definitions/tcc-status"
        },
        "startTime":{
            "type":"string",
            "description":"The time at which the TCC transaction began."
        },
        "participants":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "id",
                    "uri",
                    "status"
                ],
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"Unique transaction ID of the TCC transaction."
                    },
                    "uri":{
                        "type":"string",
                        "description":"TCC transaction participant call back url"
                    },
                    "timeLimit":{
                        "type":"string",
                        "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
                    },
                    "status":{
                        "$ref":"#/definitions/tcc-participant-status"
                    }
                }
            }
        }
    }
}

Nested Schema : participants

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "id",
            "uri",
            "status"
        ],
        "properties":{
            "id":{
                "type":"string",
                "description":"Unique transaction ID of the TCC transaction."
            },
            "uri":{
                "type":"string",
                "description":"TCC transaction participant call back url"
            },
            "timeLimit":{
                "type":"string",
                "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
            },
            "status":{
                "$ref":"#/definitions/tcc-participant-status"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(required): string

Unique transaction ID of the TCC transaction.
status(required): string

Allowed Values: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]
timeLimit: string

The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires.
uri(required): string

TCC transaction participant call back url

{
    "type":"object",
    "required":[
        "id",
        "uri",
        "status"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique transaction ID of the TCC transaction."
        },
        "uri":{
            "type":"string",
            "description":"TCC transaction participant call back url"
        },
        "timeLimit":{
            "type":"string",
            "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
        },
        "status":{
            "$ref":"#/definitions/tcc-participant-status"
        }
    }
}

400 Response

Invalid Arguments

401 Response

Unauthorized

500 Response

InternalServerError

Examples

cURL Command

The following example shows how to retrieve details of all TCC transactions 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/tcc-transaction

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.

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.

{
    "more": false,
    "tccs": [
        {
            "encryptedEntry": "uu...",
            "end": 0,
            "hostname": "otmm-tcs-0",
            "id": "3885402b-1aa0-439a-af2c-63a3ea581ed5",
            "keyVersion": "1",
            "nonce": "oQKXXe2nfnWFeeo9",
            "participants": null,
            "status": "Active",
            "thumbprint": "Bearer eyJhbGci...",
            "timeLimit": 0,
            "userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
        }
    ]
}