SOAP API Reference › Web Services Methods › exportObject

exportObject

Use this method to export a library using a Web service call.

Note: Ensure that the maximum XML size that you want to export is 250 MB.

Example

<tns:exportObject xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type-->
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:folderName>/SOAPTest/ObjectsToExport</tns:folderName>
<tns:level>2</tns:level>
<tns:isAbsolute>true</tns:isAbsolute>
<tns:downloadFileName>
<tns:downloadLocation>C:\</tns:downloadLocation>
<tns:fileName>SOAPExportedObjects.xml</tns:fileName>
<tns:overwriteFile>true</tns:overwriteFile>
</tns:downloadFileName>
<tns:filter>
<tns:exportObjectTypes>
<tns:objectType>Agenda</tns:objectType>
<tns:objectType>Calendar</tns:objectType>
<tns:objectType>CustomIcon</tns:objectType>
<tns:objectType>CustomOperator</tns:objectType>
<tns:objectType>Dataset</tns:objectType>
<tns:objectType>InteractionRequestForm</tns:objectType>
<tns:objectType>Package</tns:objectType>
<tns:objectType>Process</tns:objectType>
<tns:objectType>ProcessWatch</tns:objectType>
<tns:objectType>Resources</tns:objectType>
<tns:objectType>StartRequestForm</tns:objectType>
</tns:exportObjectTypes>
</tns:filter>
</tns:exportObject>

SOAP Request

The request contains:

• FolderName (the folder or object that you want to export)
• Folder recursion level
• Absolute/relative paths in export output
• Object types
• Download file name and the download location, where the exported library has to save.

Note: All parameters are optional with the exception of FolderName.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<tns:exportObject xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:folderName>/SOAPTest/ObjectsToExport</tns:folderName>
<tns:level>2</tns:level>
<tns:isAbsolute>true</tns:isAbsolute>
<tns:downloadFileName>
<tns:downloadLocation>C:\</tns:downloadLocation>
<tns:fileName>SOAPExportedObjects.xml</tns:fileName>
<tns:overwriteFile>true</tns:overwriteFile>
</tns:downloadFileName>
<tns:filter>
<tns:exportObjectTypes>
<tns:objectType>Agenda</tns:objectType>
<tns:objectType>Calendar</tns:objectType>
<tns:objectType>CustomIcon</tns:objectType>
<tns:objectType>CustomOperator</tns:objectType>
<tns:objectType>CustomSensor</tns:objectType>
<tns:objectType>Dataset</tns:objectType>
<tns:objectType>InteractionRequestForm</tns:objectType>
<tns:objectType>Package</tns:objectType>
<tns:objectType>Process</tns:objectType>
<tns:objectType>ProcessWatch</tns:objectType>
<tns:objectType>Resources</tns:objectType>
<tns:objectType>StartRequestForm</tns:objectType>
<tns:objectType>StatePolicy</tns:objectType>
<tns:objectType>System</tns:objectType>
</tns:exportObjectTypes>
</tns:filter>
</tns:exportObject>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ExportLibraryResponse xmlns="http://www.ca.com/itpam">
<exportLibraryResponse>Successfully uploaded the exported library to provided download file name:C:\SOAPExportedObjects.xml</exportLibraryResponse>
<downloadedServer>PAM40-W2K8-17</downloadedServer>
</ExportLibraryResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

• If you do not provide the Download File Name in the request, then the serialized library (exported library object) sends it as an attachment to the response.
• If you do not provide an accessible shared location and file name in the request, then the error response is returned to the user.
• If you provide the accessible shared location and the Download File Name, then the exported library is saved at the given location with the specified file name. The shared location is returned in response.
• If a Download File Name that you provide exists in the shared location, then the error response is returned to the user.