Archiving API data types

This section describes archiving API data types.

ArrayOfFileInfo

A complex data type that represents an array of FileInfo elements.

Schema

<xsd:complexType name="ArrayOfFileInfo">

<xsd:sequence>

<xsd:element name="FileInfo" type="typens:FileInfo"

maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

ArrayOfPermission

A complex data type that represents an array of Permission elements.

Schema

<xsd:complexType name="ArrayOfPermission">

<xsd:sequence>

<xsd:element name="Permission" type="typens:Permission"

maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

ArrayOfString

A complex data type that represents an array of String elements.

Schema

<xsd:complexType name="ArrayOfString">

<xsd:sequence>

<xsd:element maxOccurs="unbounded" minOccurs="0" name="String" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

Elements

String

Element of the String data type.

FileAccess

A simple data type that states whether a file is private or shared.

Schema

<xsd:simpleType name="FileAccess">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Private" />

<xsd:enumeration value="Shared" />

</xsd:restriction>

</xsd:simpleType>

FileInfo

A complex data type that contains file information.

Schema

<xsd:complexType name="FileInfo">

<xsd:sequence>

<xsd:element name="Id" type="xsd:string" />

<xsd:element name="Name" type="xsd:string" />

<xsd:element name="Version" type="xsd:long" />

<xsd:element name="FileType" type="xsd:string" />

<xsd:element name="FileLocation" type="xsd:string" />

<xsd:element name="Description" type="xsd:string"

minOccurs="0" />

<xsd:element name="PageCount" type="xsd:long"

minOccurs="0"/>

<xsd:element name="Size" type="xsd:long" minOccurs="0" />

<xsd:element name="TimeStamp" type="xsd:dateTime"

minOccurs="0" />

<xsd:element name="VersionName" type="xsd:string"

minOccurs="0" />

<xsd:element name="Owner" type="xsd:string" minOccurs="0" />

<xsd:element name="AccessType" type="typens:FileAccess"

minOccurs="0" />

<xsd:element name="ACL" type="typens:ArrayOfPermission"

minOccurs="0" />

<xsd:element name="DependOnFiles"

type="typens:ArrayOfFileInfo" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

Elements

The file ID.

Name

The file name.

Version

The file version number.

FileType

The file type.

FileLocation

The location of the file.

Description

A description of the file.

PageCount

The number of pages within the file.

Size

The size of the file.

TimeStamp

The timestamp on the file.

VersionName

The file version name.

Owner

The owner of the file.

AccessType

The file access type.

ACL

The access control list for the file.

DependOnFiles

A list of files that this file is dependent on.

Header

The SOAP header that contains authentication data, locale information, and other required or optional data.

Schema

<xsd:complexType name="Header">

<xsd:sequence>

<xsd:element name="AuthId" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetVolume" type="xsd:string"/>

<xsd:element minOccurs="0" name="Locale" type="xsd:string"/>

<xsd:element minOccurs="0" name="ConnectionHandle" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetServer" type="xsd:string"/>

<xsd:element minOccurs="0" name="DelayFlush" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="FileType" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetResourceGroup" type="xsd:string"/>

<xsd:element minOccurs="0" name="RequestID" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

Elements

AuthId

A system-generated, encrypted string. All requests except Login requests must have a valid AuthId in the SOAP header. The header passes this ID to Actuate iServer for validation.

TargetVolume

The Encyclopedia volume to which to direct the request.

Locale

Locale is used to format data using the language, date and time conventions, currency and other locale-specific conventions.

ConnectionHandle

An optional element that supports keeping a connection open to view a persistent report.

TargetServer

An optional element that refers to the Actuate iServer within a cluster to which to direct the request.

DelayFlush

A Boolean element that tells Actuate iServer to write updates to the disk when the value is False.

FileType

An optional element that supports specifying the file type to run, such as a BIRT design or HTMLfile.

TargetResourceGroup

An optional element that supports assigning a synchronous report generation request to a specific resource group at run time.

RequestID

A unique value that identifies the SOAP message.

Permission

A complex data type that describes access rights for roles or users.

Schema

<xsd:complexType name="Permission">

<xsd:sequence>

<xsd:choice>

<xsd:element name="RoleName" type="xsd:string" />

<xsd:element name="UserName" type="xsd:string" />

</xsd:choice>

<xsd:element name="AccessRight" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

Elements

RoleName

The role name being described.

UserName

The user name being described.

AccessRight

The privileges the user or role has on an object. One or more of the following characters representing a privilege:

D—Delete

E—Execute

G—Grant

V—Visible

S—Secure Read

R—Read

W—Write