Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• DIVA Web Services API Overview
• Oracle DIVArchive and Oracle DIVAnet
• Understanding Oracle DIVA Enterprise Connect
• Oracle DIVA Enterprise Connect Release Compatibility
• Deprecated Commands

2 Using the DIVArchive Web Services API

• DIVArchive Web Services API Conventions
  • Session Management
  • Content Type and Character Sets
  • Defaults and Required Parameters
  • Authentication
• DIVArchive SOAP Services
  • WSDL Documents
  • SOAP XML Requests
  • Error Handling
• DIVArchive REST Services
  • REST XML Requests
  • REST Form Parameter Requests
  • Error Handling
    • HTTP Errors
    • Architected Errors

3 Testing the Installation

• Testing Overview
• Using Automated Testing Tools
• Using the wsTest Scripts
  • Example Call
  • Creating Sessions Automatically
  • Editing the Templates
  • Authentication
• Calling the cURL Tool Directly

4 Digital Asset Requests

• Overview
• Archive: archiveObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Associative Copy: associativeCopy()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Copy Object and Copy To Group: copy(), copyToGroup()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Copy To New: copyToNewObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Delete Object: deleteObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Delete Instance: deleteInstance()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Restore Object: restoreObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Restore Instance: restoreInstance()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Multiple Restore Object: multipleRestoreObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Oracle DIVArchive Partial File Restore: partialRestore()
  • Major Partial File Restore Request Types
  • Input Parameters
  • Specifying Partial File Restore Selections <fileList>
    • Byte Offset
    • Timecode
    • Files and Folders
    • DPX Frame
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Transcode Archived Object: transcodeArchive()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Transfer Files: transferFiles()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example

5 Device Requests

• Eject Tape: ejectTape()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Insert Tape: insertTape()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example

6 Informational Commands

• Overview
• DIVArchive System Information: getArchiveSystemInfo()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Source/Destination Information: getSourceDestinationList()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Disk Array Information: getArrayList()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Tape Group Information: getGroupsList()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Object Information: getObjectInfo()
  • Input Parameters
  • Returned Values
  • Object Detail Parameters
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Object Query Information: getObjectDetailsList()
  • Object Query Modes
  • Tape Query Event Types
  • Batching and List Position
  • Continuous Polling for Updates
  • Input Parameters
  • Returned Values
  • Tape Query Returned Values
  • DIVArchive Status Codes
  • REST Object Query Request Example
  • REST Object Query Response Example
  • REST Tape Query Request Example
  • REST Tape Query Response Example
• Object Files and Folders Information: getFilesAndFolders()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Request Information: getRequestInfo()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Partial File Restore Request Information: getPartialRestoreRequestInfo()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Finished Requests: getFinishedRequestList()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Storage Plan Information: getStoragePlanList()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example

7 Miscellaneous Commands

• Overview
• Creating a Session: registerClient()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Changing the Request Priority: changeRequestPriority()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Canceling a Request: cancelRequest()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Adding a Tape Group: addGroup()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Deleting a Tape Group: deleteGroup()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Locking an Object: lockObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Unlocking an Object: unlockObject()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Linking Objects: linkObjects()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Marking an Object Instance Required: require()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Marking an Object Instance Releasable: release()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Enabling Automatic Repack: enableAutomaticRepack()
  • Input Parameters
  • Returned Values
  • DIVArchive Status Codes
  • REST Request Example
  • REST Response Example
• Deprecated Commands

A DIVA Enterprise Connect Status Codes