Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Overview

• Limitations

2 Using the API

• Accessing the Web Services Description Language File
• API Functions
  • Invoking API Functions
• Signatures
  • General Notes

3 Status Services

• General Status Services
  • getJobResult
    • Format
    • Parameters
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • getJobStatus
    • Format
    • Parameters
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault
• Volume and Drive Status Services
  • getAllDriveInfo
    • Format
    • Input Type
    • Response
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • getAllVolumeInfo
    • Format
    • Response
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • getVolumeInfoByStatus
    • Format
    • Input Type
    • Response
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • getVolumeInfoByVolser
    • Format
    • Parameter
    • Roles
    • Exceptions Thrown
    • Recommended Timeout
    • SOAP Request
    • SOAP Response
    • SOAP Fault

4 Management Services

• Overview
  • assignVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • ejectVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • enterVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • finalizeVolume
    • Format
    • Response
    • Parameters
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • formatVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • formatVolumeWithDrive
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • getVolumePath
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • offlineVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • onlineVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • prepareVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • unassignVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • unformatVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Error
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • unformatVolumeWithDrive
    • Format
    • Parameters
    • Response
    • Exception Thrown
    • Roles
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault
  • vaultVolume
    • Format
    • Parameters
    • Response
    • Roles
    • Exception Thrown
    • Recommended Timeout
    • Recommended Job Poll Interval
    • Job Errors
    • SOAP Request
    • SOAP Response
    • SOAP Fault

Glossary

Index