New-ASPackageRequest
A REST API to be called by an external system. When you send a request through an external system, request will automatically lands in the package backlog in the AdminStudio and will avoid manual communication for the package request. The package details will be inserted in the Backlog tab of the AdminStudio.
Edition:REST APIs are enabled with AdminStudio Enterprise Edition.
You can use the New-ASPackageRequest API to add Package Request catalog item keywords to the Application Catalog.
This API provide details related to Package request.
|
Request Type |
Description |
|||||||||||||||
|
API |
http://localhost:8086/catalog/packagerequest/?{Product=XYZ}&{Vendor=XYZ}&{Version=0.0.0}&{Priority=n}&{Source=XYZ} |
|||||||||||||||
|
Method |
POST |
|||||||||||||||
|
Connection Info |
Provides the connection information of the package as mentioned in Setting Up Connection to Run REST APIs |
|||||||||||||||
|
Parameters |
List all packages in the catalog in the following format:
Note:Priority value should not exceed more than 5. If the value of Priority is empty or invalid, then the default value will be used as a Priority. The default value of the Priority will be 3. |
|||||||||||||||
|
Response |
<response> <HasFault>false</HasFault> <headers> <httpHeaders> <Content-Length>0</Content-Length> <Accept-Encoding>gzip, deflate, br</Accept-Encoding> <Host>10.80.149.30:8086</Host> <Accept>*/*</Accept> <ConnectionInfo>"PROVIDER=SQLNCLI11;Data Source=10.00.000.00;Initial catalog=AS_2Feb;user ID=xx;password=xxxxxx;IntegratedSecurity=SSPI"< ConnectionInfo> <Postman-Token>027e8317-56cd-4705-84b7-bb9556cbe143</Postman-Token> <User-Agent>PostmanRuntime/7.26.8</User-Agent> <Connection>keep-alive</Connection> </httpHeaders> <request></request> </headers> <summary /> <data> <data> <Receipt xmlns:json="http://james.newtonking.com/projects/json" json:id="1"><ReceiptID>be2c718b-91d7-413c-b2a8-4a45ebac96bb</ReceiptID> <FileName /> <GroupPath /> <ParentReceipt /> <PackageID>0</PackageID> <TestIDs /> <PluginGUID>00000000-0000-0000-0000-000000000000</PluginGUID> <PackageFeedId>0</PackageFeedId> <FixTransformPath /> <DeploymentData /> <WrapData /> <UpdatePackageData /> <NonPluginTestData /> <PackageConversionData /> <PackageFeedRequestData /> <PackageFeedAutomationRequestData /> <BacklogItemRequestData> <Product>Microsoft ODBC Driver</Product> <Vendor>Microsoft</Vendor> <Version>17.6.1.1</Version> <Source>FlexeraOne</Source> <Priority>4</Priority> </BacklogItemRequestData> <State>0</State> <StateDescription>New Transaction</StateDescription> <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-02-05T06:33:11.4756398Z</TimeCreated> <CancelTokenSource> <IsCancellationRequested>false</IsCancellationRequested> <Token> <IsCancellationRequested>false</IsCancellationRequested> <CanBeCanceled>true</CanBeCanceled> <WaitHandle> <Handle> <value>624</value> </Handle> <SafeWaitHandle> <IsInvalid>false</IsInvalid> <IsClosed>false</IsClosed> </SafeWaitHandle> </WaitHandle> </Token> </CancelTokenSource> <ExistingPackageId>0</ExistingPackageId> <EnforceDuplicateDetection>false</EnforceDuplicateDetection> <GenerateSoftwareTag>false</GenerateSoftwareTag> </Receipt> <ClientID> <UniqueID>00000000-0000-0000-0000-000000000000</UniqueID> <Database>XXXX</Database> <Server>10.00.000.00</Server> <User>sa</User> </ClientID> </data> </data> </response> Note:By using ReceiptID, you can see the transaction messages for the request. For more details, see Get Status of a Request. |