The web services discussed in this document are only available in the LTFS-LE 1.0.4 release of the software.
Programmers can obtain the supported signature of the Web Service available from the installed version of LTFS-LE software from the Web Services Description Language 1.1 (WSDL) file. This file can be accessed from the following location:
https://server.mydomain.com:7002/LTFS/LTFSLEWS?WSDL
In the above example, server.mydomain.com is the hostname and domain name.
For some programming instances, you may need the following port name:
port name="LTFSLEWSSoap12HttpPort"
The back-end execution times of the LTFS LE Web Services vary. Web Services that pertain to the status of the volume or operation can be returned quickly. However, the execution time of some Web Services depends on several factors out of control of the software. Mechanical factors such as user actions cannot be predicted by software. For example, certain Web Services such as the Assign Volume service may take longer if the volume contains a lot files. Using a different example, the completion of the eject operation depends on the operator walking up to the library and removing the volume from the CAP.
In order to address these discrepancies, and yet provide a consistent programmatic interface across all the Web Services calls, the API service call returns immediately. The returned results will depend on the type of service. The LTFS LE has two categories of Web Services:
Status services
Status services are the services that enables users to get the volume and drive status. For more information, see "Status Services".
Management services
Management services are the services that manage the hardware resources. For example, use a management service to enter a volume, eject a volume, and bring a volume online or offline. For more information, see "Management Services".
The management services use a two-step process to invoke an API function and return results:
Invoke the function. A unique request job ID is immediately returned.
Invoke the getJobStatus function, specifying the job ID returned in step 1.
This returns a one of the following job statuses:
0 (Web service call associated with job ID is complete.)
1 (Web service call associated with job ID is still in progress.)
-1 (No such web service call with job ID is found in the system.)
The LTFS-LE Web Services signatures include each SOAP request message format, SOAP response message format and SOAP fault message format. All LTFS LE Web Services only support SOAP messages. The SOAP message format implements SOAP 1.2 specification. Refer to "Status Services" and "Management Services" for the valid SOAP signature for each function.
The Web Services outlined in this document are only available in the LTFS-LE 1.0.4 release of the software.
All Web Service APIs are only accessible through HTTPS.
Using WS-Security, all Web Service API SOAP request messages include a username token in the SOAP header in which the username and password are all in plain text
The username and password is used in username token as an example only. It must be replaced by a valid username and password
All the data used in the SOAP request and response message are example data only to show the SOAP request and response message data structure.