Web Service API

The VDI web service API is a new web service in Visual Enterprise Generator 8.0 for triggering and managing VDI workflow jobs. It is used by the Upload Client to start and manage conversion jobs, and can also be used by third parties for a more advanced integration with Visual Enterprise Generator.

Getting Started

Please refer to note 1694219 , attachment UploadClient_WebService_Template_VEG_90.ZIP, for the WSDL for this web service. The WSDL file is named UploadClient_ERPIntegration_WSDL.WSDL, use this file to generate your proxies for communicating with this service.

Consumers of this web service must support streaming MTOM in order to upload files to be used by jobs, this is supported by .NET and modern Java web service stacks.

Workflow List

To get the list of possible VDI workflows that jobs can be started for, the method WorkflowGetAvailable() can be called without having performed any authentication.

WorkflowGetAvailableResponse

This is the response object returned by WorkflowGetAvailable().

WorkflowSystemConnection

Authentication

In order to use any of the authenticated web service calls, a call to the UserAuthenticate() web service method must be performed to obtain a session ID which should be supplied with all subsequent requests, and acts as an authentication token.

If authentication fails, a SOAP fault will be raised by this call with more information.

UserAuthenticateRequest

This is the request object which must be passed into UserAuthenticate().

UserAuthenticateResponse

This is the response object returned by UserAuthenticate() in the event of successful authentication.

Deauthentication

In order to preemptively clear user sessions, the method UserDeauthenticate() can be called to delete a session and all information associated with it.

UserDeauthenticateRequest

This is the request object which must be passed in to UserDeauthenticate().

UserDeauthenticateResponse

This object contains no fields.

File Uploading

All conversion jobs started using this web service require an input file in order to start. This file should be uploaded to the server first before starting the job.

The sequence of events is as follows:

1. The FileUploadBegin() method is called to obtain a unique ID for the file to be uploaded.
2. The FileUploadChunk() method is called as many times as needed to transfer all the file data to the server.
3. The FileUploadEnd() method is called to mark an uploaded file as complete. After making this call the file unique ID can be passed to methods that expect it.

FileUploadBegin()

This method generates a new unique ID to use for subsequent file upload calls.

FileUploadBeginRequest

This is the request object that must be passed into the FileUploadBegin() call.

FileUploadBeginResponse

This is the response object returned by the FileUploadBegin() call.

FileUploadChunk()

This method uploads a chunk of a file to the server. If an error occurs, a SOAP fault will be raised by this call, containing additional information.

FileUploadChunkRequest

This is the request object that must be passed into the FileUploadChunk() call.

FileUploadChunkResponse

This object contains no fields.

FileUploadEnd()

This methods marks a file which was being uploaded as completed. The file cannot be written to after this call.

FileUploadEndRequest

This is the request object that must be passed into the FileUploadEnd() call.

FileUploadCancel()

This methods removes all information for a file which was being uploaded. The file cannot be written to after this call, and the unique ID no longer exists on the server.

FileUploadCancelRequest

This is the request object that must be passed into the FileUploadCancel() call.

Starting Jobs

Once the input file to a job has been uploaded, the job can be started by invoking JobStartWithUploadedFile(). If the job could not be started successfully, a SOAP fault is raised.

JobStartWithUploadedFileRequest

This is the request object that must be passed into the JobStartWithUploadedFile() call.

JobStartWithUploadedFileResponse

This is the response object returned by the JobStartWithUploadedFile() call.

Canceling Jobs

 To cancel a currently running job, the JobCancel() method can be invoked. If the job could not be canceled successfully, a SOAP fault is raised.

JobCancelRequest

JobCancelResponse

 This object contains no fields.

Job Monitoring

To query the status of running jobs, in order to determine whether or not they have completed, the JobGetStatus() call can be used.

JobGetStatusRequest

This is the request object that must be passed into the JobGetStatus() call.

JobGetStatusResponse

This is the response object returned by the JobGetStatus() call.

JobStatusInfo

This is the type of an element in the Jobs field of the JobGetStatusResponse object.

Job Results

After a job completed successfully, it can be useful to programmatically retrieve information about what actions the job performed. As an example, it is possible to programmatically determine the SAP DIR IDs for completed jobs, as well as whether or not those jobs have viewables attached to the DIRs.

This is achieved by calling the JobGetResult() method.

JobGetResultRequest

This is the request object that must be passed into the JobGetResult() call.

JobGetResultResponse

This is the response object returned by the JobGetResult() call.

JobResultInfo

This is the type of an element in the Jobs field of the JobGetResultResponse object.

JobGetLocalizedReportRequest

This is the request object passed to JobGetLocalisedReportAsXml().