Actuate Information Delivery API operations : GetVolumeProperties
 
GetVolumeProperties
Retrieves properties of a specific volume.
Request schema
<xsd:complexType name="GetVolumeProperties">
<xsd:sequence>
<xsd:element name="ResultDef" type="typens:ArrayOfString">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Request elements
ResultDef
*The properties to retrieve. By default, VolumeProperties are always returned. In addition, you can specify the following properties:
*ArchiveLibrary
*AutoArchiveSchedule
*ExternalUserPropertyNames
*OnlineBackupSchedule
*TranslatedRoleNames
*PrinterOptions
*VolumeProperties
Response schema
<xsd:complexType name="GetVolumePropertiesResponse">
<xsd:sequence>
<xsd:element name="VolumeProperties" type="typens:Volume"/>
<xsd:element name="TranslatedRoleNames"
type="typens:ExternalTranslatedRoleNames" minOccurs="0"/>
<xsd:element name="ExternalUserPropertyNames"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="PrinterOptions"
type="typens:ArrayOfPrinterOptions" minOccurs="0"/>
<xsd:element name="AutoArchiveSchedule"
type="typens:JobSchedule" minOccurs="0"/>
<xsd:element name="ArchiveLibrary" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ArchiveServiceCmd" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EventOptions" type="typens:EventOptions"
minOccurs="0"/>
<xsd:element name="LicenseOptions"
type="typens:ArrayOfLicenseOption" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
VolumeProperties
The volume properties.
TranslatedRoleNames
The translated role names.
ExternalUserPropertyNames
The external user properties.
PrinterOptions
The printer options.
AutoArchiveSchedule
The autoarchive schedule.
ArchiveLibrary
The name of the archive application for the Encyclopedia volume.
ArchiveServiceCmd
The archive service command for the Encyclopedia volume.
LicenseOptions
The license options for the Encyclopedia volume.