All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
PackageStreamingService Class Reference

Package Streaming Service More...

Public Member Functions

Stream ExportPackageToStream ()
 Exports the package to stream. More...
 
SpaPackageImportResult ImportPackageFromStream (Stream packageData)
 Imports the package from a stream. More...
 

Description

Package Streaming Service

Member Functions

Stream ExportPackageToStream ( )

Exports the package to stream.

Returns
Returns the stream of the exported package
Remarks
This API is not supported to be called from TotalAgility processes or forms, it is only callable from custom code. Use this API to export the package to a client machine that is calling a remote TotalAgility server.This API requires following custom headers to be passed. 1.A custom header named ‘SessionId’ with a string that uniquely identifies the session for the current logged on user 2. custom header named ‘PackageExportInfo’ which holds the json string of the object of the class SpaPackageExportInfo. For Base package, an example JSON format will be as follows: {"Id":"893DF191DD6544868021ABCBC5EC209D","Name":"BasicPackage","Version":1, Deployment": null} For Deployment package, an example JSON format will be as follows{"Id":"893DF191DD6544868021ABCBC5EC209D","Name":"BasicPackage","Version":1, Deployment":{"Id":"E77115BC57A84545848603C8F5FBB858","Name":"1"}}.
SpaPackageImportResult ImportPackageFromStream ( Stream  packageData)

Imports the package from a stream.

Parameters
packageDataThe package data that needs to be imported. While importing LastModified date and version is updated with package data Last Modified Date and Version.
Returns
An SpaPackageImportResult object containing details of the artifacts that are failed to import.
Remarks
This API is not supported to be called from TotalAgility processes or forms, it is only callable from custom code. Use this API to export the package to a client machine that is a calling a remote TotalAgility server.This API requires the following custom headers to be passed. 1. A custom header named ‘SessionId’ with a string that uniquely identifies the session for the current logged on user.2. A custom header named ‘PackageImportOptions’ with a json string of the object of the class SpaPackageImportOptions. Example of JSON Object: {"ImportFormRoleMembers":false,"ImportFormSecurityTokens":false,"ImportFormSecurityRoles":false,"ImportFormWebServices":true,"OverwriteFormGlobalVariables":true,"OverwriteServerVariables":true, "OverwriteNonVersionedItems": false, "SpaPackageImportType":0, "OverwriteExistingDevices": false, "OverwriteExistingDevicesProfiles": false, "OverwriteExistingDeviceSettings": false }.