Invoke-ASPublish

AdminStudio 2021 | 21.0 | AdminStudio REST APIs

Edition:REST APIs are enabled with AdminStudio Enterprise Edition.

When you send this request, it will publish a package to a deployment server.

Invoke-ASPublish API Information

Request Type

Description

API

http://localhost:8086/catalog/publish/{ApplicationID}?TargetGroup={Applications\Group1}&ConnectionName={Distribution Server Name}

Method

POST

Parameters

List all parameters in the following format:

ApplicationID = Specify the ApplicationID of the application you are publishing. To get ApplicationID, see Get-ASApplicationID.
TargetGroup = Specify the target group on the deployment server that you want to publish this application to.
ConnectionName = Use to specify named connection to a deployment system.

Connection Info

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

Response

Example: http://localhost:8086/catalog/publish/28?TargetGroup=Applications\TestGroup&ConnectionName=SCCM 2010

<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>1a7becba-db8b-4932-8851-401700d738ba</Postman-Token><Content-Length>0</Content-Length></httpHeaders><request></request></headers><summary /><data><data><Receipt xmlns:json="http://james.newtonking.com/projects/json" json:id="1"><ReceiptID>5738f44c-346c-4c88-8104-2223121c47b8</ReceiptID><FileName /><GroupPath /><ParentReceipt /><PackageID>0</PackageID><TestIDs /><PluginGUID>00000000-0000-0000-0000-000000000000</PluginGUID><PackageFeedId>0</PackageFeedId><FixTransformPath /><DeploymentData><SystemName /><Server /><UserName /><Password /><SiteName /><ApplicationID>28</ApplicationID><ShareDirectory /><TargetGroup>Applications\TestGroup</TargetGroup><ConnectionName>SCCM 2010</ConnectionName><DependentApplication>false</DependentApplication><PluginID /><CustomData /></DeploymentData><WrapData /><AppAttachData /><UpdatePackageData /><NonPluginTestData /><PackageConversionData /><PackageFeedRequestData /><PackageFeedAutomationRequestData /><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-04-16T12:37:52.4517933Z</TimeCreated><CancelTokenSource><IsCancellationRequested>false</IsCancellationRequested><Token><IsCancellationRequested>false</IsCancellationRequested><CanBeCanceled>true</CanBeCanceled><WaitHandle><Handle><value>6084</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>

Note:By using ReceiptID, you can see the transaction messages for the request. For more details, see Get Status of a Request.