Get Transaction

Using this API, details of the available transactions can be taken.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/jsons

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_user/tms/{tmsId}/result

note

This API is applicable only for SHIFT based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Object	This denotes the User details.
id	String	This denotes the ID of the transaction.
status	String	The status of the API call. Refer Response status Information for details.
startedAt	String	This explains the time the transaction started.
retrievalTimeout	Integer	The time in seconds clients have to retrieve the TMS, Default: 300.
tmsTimeout	Integer	The time in seconds that the clients have to answer to a TMS after retrieving it,Default: 600.
userId	String	The user's ID.
astClientIds	String	An explicit non-empty set of client IDs of the TMS is sent, Default: unset.

Sample Response

{
    "message": "Retrieved tms data successfully",
    "status": "OK",
    "subSystem": 2,
    "data": {
        "info": {
            "id": "01GQFRE72GZYXTFJ10W4C9Y8YP",
            "status": "ACCEPTED",
            "startedAt": "2023*01*23T16:47:31.9209Z",
            "retrievedAt": "2023*01*23T16:47:32.368051Z",
            "completedAt": "2023*01*23T16:47:34.054639Z",
            "retrievalTimeout": 50,
            "tmsTimeout": 50,
            "userId": "5b86b055*6644*4149*963d*01e5dd2072b6",
            "astClientIds": [
                "01GQFDATADK13BV8RCM1ZV2BMT"
            ]
        },
        "signedData": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwFwYJKoZIhvcNAQcBoAoECHRlc3QgVE1ToIAwggMrMIRQr/m4TLmntmHNJQr2rKX8hY5mtKJsVMfJfU1KUAzgNLqzxIUmUY+FRSoOxum7KhKLXd27azQ5AAAAAAAA",
        "completedBy": "01GQFDATADK13BV8RCM1ZV2BMT"
    }
}

Response Status Information

Status Code	Status	Message
200	OK	Retrieved tms data successfully
401	Unauthorized	HTTP 401 Unauthorized
404	NOT FOUND	TMS Result Not found