View source for REST API:package Resource

This resource provides the ability to download and subscribe to packages using the [[REST API]].

:''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
__TOC__
===Permissions===
{{permissions|Manage Packages|use this resource.}}

=== Subscribe to a Package === 
;Method:POST
 
;URI:<tt><nowiki>https://{domain}/networking/rest/package/operation/subscribe?{query_parameters}</nowiki></tt> 

{{Query Parameters|
:*<tt>packageId</tt> - The unique package identifier. 
<!-- 
:*<tt>version</tt> - The package version number (optional).
-->
:*<tt>fileName</tt> - The path to the package file, when subscribing to a downloaded copy of the package. ([[Subscribe from File]] tenant capability must be enabled to use this option.)}} 

;Examples:
:*Subscribe from repository:<br/>
::https://{domain}/networking/rest/package/operation/subscribe?packageId=123123123
:*Subscribe from repository, specifying a version number:<br/>
::https://{domain}/networking/rest/package/operation/subscribe?packageId=123123123&version=1.2
:*Subscribe from a file:<br/>
::https://{domainname}/networking/rest/package/operation/subscribe?fileName=C:\package.zip

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

====Sample Package Subscribe Client ==== 
{{:REST API:PackageSubscribeClient}}

===Download a Package===
Download a package as a zip file.
;Method:POST
;URI:<tt><nowiki>https://{domain}/networking/rest/package/operation/download/{package_id}?{query_parameters}</nowiki></tt>
{{Query Parameters|
:*<tt>lastPublishedVersion</tt>
::* If TRUE, the package downloaded will be the last published version. ('''Default''') If the package has never been published, it will be published first, so that it can be downloaded.
::* If FALSE, the package will be re-assembled/re-created, and this version will include all changes made to the components, from the last package publish date. (If any components of the package have been checked out, the request returns an Error.)}}

;Response:
The response is of type multipart/mixed.
:*On success it will contain two parts which look something like this
:<syntaxhighlight lang="xml" enclose="div">
-----------------------------103832778631715
     content-type: application/xml
 
     <platform>
        <message>
            <code>0</code>
            <description>Success</description>
        </message>
    </platform>
 
-----------------------------103832778631715
content-type: application/octet-stream
 
Encoded file part
-----------------------------103832778631715--
</syntaxhighlight>

:*On failure it will contain just a single part which looks something like this
:<syntaxhighlight lang="xml" enclose="div">
-----------------------------103832778631715
     content-type: application/xml
 
     <platform>
        <message>
            <code>0</code>
            <description>Success</description>
        </message>
    </platform>
-----------------------------103832778631715--
</syntaxhighlight>

:See also: [[REST API:Error Codes|REST API Error Codes]]


====Sample Package Download Client Program==== 
{{:REST API:PackageDownloadClient}}


===Deploy a Package===
Deploy a package to a list of tenants, where both the package to deploy and the tenant list are specified in the request. 

;Additional Permissions:
:In addition to the [[Manage Packages]] permission, [[Mass Deployment of Packages to Tenants]] must be enabled for the publishing tenant.

;Method:POST
 
;URI:<tt><nowiki>https://{domain}/networking/rest/package/operation/deploy</nowiki></tt> 

;Request:
:<syntaxhighlight lang="xml" enclose="div">
<package>
    <id>123123123</id>
    <deployConfiguration>
        <tenantList>
            <tenantId>1214573329</tenantId>
            <tenantId>1224242818</tenantId>
              ...
        </tenantList>
        <notifyTenants>false</notifyTenants>
        <deployTime>0</deployTime>  
    </deployConfiguration>
</package>
</syntaxhighlight>

;Response:
Returns the id of the submitted import job, along with a message telling whether or not the job was accepted for processing. (Use the REST [[REST API:packageDeploy Status Resource|packageDeploy Status]] resource to follow the progress of the job.)

:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>      <!-- job ID for the deployment process -->  
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

===Fields===

====DeployConfiguration====
:{| border="1" cellpadding="5" cellspacing="1"
|'''Name'''||'''Type'''||'''Required on Add'''||'''Description'''||'''Additional Info'''
|-
|<tt>tenantList</tt>||List||align="center"|[[File:Checkmark.gif|link=]]||List of tenants to deploy the package to ||
|-
|<tt>notifyTenants</tt>||Boolean||align="center"|[[File:Checkmark.gif|link=]]||If true, send a message to notify tenants about package deployment||
|-
|<tt>deployTime</tt>||Date||align="center"|[[File:Checkmark.gif|link=]]||Deployment date/time<br/>0=Deploy immediately||[[UTC Format]]
|-
|}

====TenantList====
:{| border="1" cellpadding="5" cellspacing="1"
|'''Name'''||'''Type'''||'''Required on Add'''||'''Description'''||'''Additional Info'''
|-
|<tt>tenantId</tt>||String||align="center"|[[File:Checkmark.gif|link=]]||Tenant ID||
|-
|}
<noinclude>

[[Category:REST API|package Resource]]
</noinclude>