Getting Status of a Request

AdminStudio 2023 | 25.0 | AdminStudio REST APIs

Edition:REST APIs are enabled with AdminStudio Enterprise Edition.

When you send this request, it will give details of the requested transaction (ReceiptID) given.

Getting Status of a Request API Information

Request Type

Description

API

http://localhost:8086/message/transactions/{ReceiptID}/details

Method

GET

Parameters

List all parameters in the following format:

• ReceiptID = Specify the receipt id from the postman responses.

Connection Info

Provides the connection information of the package as mentioned in Setting Up Connection to Run REST APIs 

Response

Example: http://localhost:8086/message/transactions/146f8997-b96c-4927-8483-12e32a31ab32/details

<response>

<HasFault>false</HasFault><headers><httpHeaders><Host>localhost:8086</Host><Connection>keep-alive</Connection><Accept>*/*</Accept><User-Agent>PostmanRuntime/7.26.10</User-Agent><Accept-Encoding>gzip, deflate, br</Accept-Encoding><Postman-Token>c3ae5f7c-ccbf-4ae6-b2f1-3526ec508c3f</Postman-Token></httpHeaders><request></request></headers><summary /><data><data><Receipt xmlns:json="http://james.newtonking.com/projects/json" json:id="1"><ReceiptID>146f8997-b96c-4927-8483-12e32a31ab32</ReceiptID><FileName /><GroupPath /><ParentReceipt /><PackageID>0</PackageID><TestIDs /><PluginGUID>00000000-0000-0000-0000-000000000000</PluginGUID><PackageFeedId>0</PackageFeedId><FixTransformPath /><DeploymentData /><WrapData /><AppAttachData /><UpdatePackageData /><NonPluginTestData /><PackageConversionData /><PackageFeedRequestData /><PackageFeedAutomationRequestData /><BacklogItemRequestData /><State>5</State><StateDescription>Error in Transaction</StateDescription><Messages><TransactionID>146f8997-b96c-4927-8483-12e32a31ab32</TransactionID><CreateDateTime>2021-04-19T01:07:18.9174237-07:00</CreateDateTime><ReadDateTime>2021-04-19T01:07:54.2949074-07:00</ReadDateTime><Text>Upgrade of catalog "XXXXX" Failed : Catalog is at the same level as the requested upgrade</Text><MsgID>0</MsgID><Type>3</Type></Messages><CustomData /><Progress><TransactionID>00000000-0000-0000-0000-000000000000</TransactionID><Start>0</Start><End>0</End><Current>0</Current><StepSize>0</StepSize></Progress><LastMessageID>-1</LastMessageID><Release>false</Release><TimeCreated>2021-04-19T08:07:54.293908Z</TimeCreated><CancelTokenSource><IsCancellationRequested>false</IsCancellationRequested><Token><IsCancellationRequested>false</IsCancellationRequested><CanBeCanceled>true</CanBeCanceled><WaitHandle><Handle><value>3488</value></Handle><SafeWaitHandle><IsInvalid>false</IsInvalid><IsClosed>false</IsClosed></SafeWaitHandle></WaitHandle></Token></CancelTokenSource><ExistingPackageId>0</ExistingPackageId><EnforceDuplicateDetection>false</EnforceDuplicateDetection><GenerateSoftwareTag>false</GenerateSoftwareTag></Receipt></data></data>

</response>