Web Service: DvsClipsterWebservice
To use the web service you need a proper license. Furthermore, the web service must be enabled as well as configured correctly in the CLIPSTER software and its user interface must be running on the client to which you want to connect.
For a successful communication with the CLIPSTER web service most commands require a handle that must be explicitly requested from the software first. It has to be passed as a header element in subsequent calls to the web service. Once you are finished using the web service, the handle should be released. To manually force the release of a handle close the user interface of the CLIPSTER software on the SOAP client. Then the handle will be void.
The web service expects the commands in XML format. The XML as well as the data to be sent are case-sensitive.
When sending predefined control strings (restricted strings), you may, instead of sending the string, send the enumeration constant (enum const) as detailed in the WSDL source code (see "Source code" links).
Port DvsClipsterWebserviceHttpPort Port type Source code
- ConfigClose Detail Source code
- ConfigGet Detail Source code
- ConfigLoad Detail Source code
- DesktopMessageDiscard Detail Source code
- DesktopMessageGetStatus Detail Source code
- DesktopMessageInvoke Detail Source code
- JobControl Detail Source code
- JobGetIDs Detail Source code
- JobGetStatus Detail Source code
- JobStart Detail Source code
- ProjectClose Detail Source code
- ProjectGet Detail Source code
- ProjectLoad Detail Source code
- ProjectNameGet Detail Source code
- ProjectPropertyGet Detail Source code
- ProjectPropertySet Detail Source code
- SystemGetHandles Detail Source code
- SystemGetLastMessages Detail Source code
- SystemGetStatus Detail Source code
- SystemReleaseHandle Detail Source code
- SystemRenewHandle Detail Source code
- SystemRequestHandle Detail Source code
- TCPCommandWrapper Detail Source code
- TimelineMarkerPositionGet Detail Source code
Operations
-
ConfigClose
Description:Saves the global settings that are currently set to a file.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ConfigClose (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigClose[ConfigLocationURL] --- The location and file name for the global settings to be saved (e.g. file:///V:/settings/some_config_file.cgs). When left empty, they will be saved in the file soapdefault.cgs in the system base video directory.
[ForceSave] --- Obsolete. Leave empty.
- ConfigLocationURL - optional; type anyURI
- ForceSave - optional; type boolean
Output:ConfigCloseResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigCloseResponse- ConfigLocationURL type string
-
ConfigGet
Description:Returns the specified global settings file as a data string.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ConfigGet (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigGet[ConfigLocationURL] --- The location and file name of the global settings file that should be returned (e.g. file:///V:/settings/some_config_file.cgs).
- ConfigLocationURL type anyURI
Output:ConfigGetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigGetResponse- ConfigData type string
-
ConfigLoad
Description:Loads a global settings file either by specifying an existing global settings file on the SOAP client or by providing a complete *.cgs file (valid for the SOAP client) as an XML string.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ConfigLoad (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigLoad[ConfigLocationURL] --- The location and file name of either the global settings file to load or for the XML string to be saved if [ConfigContent] is provided (e.g. file:///V:/settings/some_config_file.cgs).
[ConfigContent] --- The content of a complete global settings file as an XML string.
[ForceLoad] --- Obsolete. Leave empty.
- ConfigLocationURL type anyURI
- ConfigContent - optional; type string
- ForceLoad - optional; type boolean
Output:ConfigLoadResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ConfigLoadResponse- ConfigLocationURL type string
-
DesktopMessageDiscard
Description:Closes the message box that is shown on the CLIPSTER system.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:DesktopMessageDiscard (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageDiscardNo parameters.Output:DesktopMessageDiscardResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageDiscardResponse
-
DesktopMessageGetStatus
Description:Returns status information about the message box displayed on the CLIPSTER system and its buttons.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:DesktopMessageGetStatus (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageGetStatusNo parameters.Output:DesktopMessageGetStatusResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageGetStatusResponse[ButtonNameClicked] --- A comma-separated string of the button names that were clicked. Each time this command is called this value will be erased afterwards.
[State] --- Shows the current state (visibility) of the message box.
- ButtonNameClicked type string
- State type DesktopMessageStateEnum - type string with restriction - enum { 'DMSTATE-UNKNOWN', 'DMSTATE-ON', 'DMSTATE-OFF' }
-
DesktopMessageInvoke
Description:This command allows for an interaction with the desktop of the remote controlled CLIPSTER system. The message that is sent will pop up a message box (window) on the screen of the CLIPSTER system. Only the last message that has been sent will be shown. The user at the system can interact with it by pressing buttons.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:DesktopMessageInvoke (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageInvoke[Caption] --- The title of the message box.
[Text] --- The text of the message.
[Icon] --- The icon that should be shown for the message. You can choose between no icon, an icon for an information, for a question, for a warning, or for a critical message.
[TypeFlagList] --- Determines the type of message box that will be shown.
DMMESSAGE-LOCK
will show predefined messages that lock the user interface and indicate that the web service is in use.DMMESSAGE-FULLSCREEN
shows the message in fullscreen.DMMESSAGE-FLASHING
shows a flashing message box.DMMESSAGE-CLOSEABLE
allows the message box to be closed by the user.[ButtonNameList] --- A comma-separated list of the button names that should be shown thereby determining the number of buttons in the message box.
- Caption - optional; type string
- Text - optional; type string
- Icon - optional; type DesktopMessageIconEnum - type string with restriction - enum { 'DMICON-UNKNOWN', 'DMICON-NONE', 'DMICON-INFO', 'DMICON-QUESTION', 'DMICON-WARNING', 'DMICON-CRITICAL' }
- TypeFlagList - optional, unbounded; type DesktopMessageTypeEnum - type string with restriction - enum { 'DMMESSAGE-UNKNOWN', 'DMMESSAGE-LOCK', 'DMMESSAGE-FULLSCREEN', 'DMMESSAGE-FLASHING', 'DMMESSAGE-CLOSEABLE' }
- ButtonNameList - optional, unbounded; type string
Output:DesktopMessageInvokeResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type DesktopMessageInvokeResponse -
JobControl
Description:Controls the specified job.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:JobControl (SOAP:body, use = literal, part = Handle)Source codeparameters type JobControl[JobID] --- The ID of a job. When left empty, it means the job that is currently running.
[JobControlType] --- Determines what to perform with the job.
- JobID - optional; type string
- JobControlType type JobControlTypeEnum - type string with restriction - enum { 'JOBCONTROL-UNKNOWN', 'JOBCONTROL-STOP' }
Output:JobControlResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type JobControlResponse- JobID type string
- JobControlType type JobControlTypeEnum - type string with restriction - enum { 'JOBCONTROL-UNKNOWN', 'JOBCONTROL-STOP' }
-
JobGetIDs
Description:Returns all job IDs.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:JobGetIDs (SOAP:body, use = literal, part = Handle)Source codeparameters type JobGetIDsNo parameters.Output:JobGetIDsResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type JobGetIDsResponse
- JobIDList - optional, unbounded; type string
-
JobGetStatus
Description:Returns status information about the specified job.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:JobGetStatus (SOAP:body, use = literal, part = Handle)Source codeparameters type JobGetStatus[JobID] --- The ID of a job. When left empty, it means the job that is currently running.
- JobID - optional; type string
Output:JobGetStatusResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type JobGetStatusResponse- JobID type string
- Type type JobTypeEnum - type string with restriction - enum { 'JOBTYPE-UNKNOWN', 'JOBTYPE-PLAYOUT', 'JOBTYPE-FINALIZE', 'JOBTYPE-INGEST', 'JOBTYPE-DISPLAY' }
- Status type JobStatusTypeEnum - type string with restriction - enum { 'JOBSTATUS-UNKNOWN', 'JOBSTATUS-RUNNING', 'JOBSTATUS-FINISHED', 'JOBSTATUS-CANCELED', 'JOBSTATUS-ABORTED' }
- Progress type double
- TimeRemaining type time
- TimeStart type dateTime
- TimeFinished type dateTime
- LastErrorText type string
- LastErrorCode type int
-
JobStart
Description:Starts a job, for example, a finalize, ingest or play-out job.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:JobStart (SOAP:body, use = literal, part = Handle)Source codeparameters type JobStart[JobType] --- The type of job that should be performed.
JOBTYPE-PLAYOUT
performs a play-out in the Playout mode of the I/O Tool,JOBTYPE-FINALIZE
performs a finalizing of the currently loaded project,JOBTYPE-INGEST
starts a record operation in the Autoedit mode of the I/O Tool, andJOBTYPE-DISPLAY
initiates a play-out of the currently loaded project in the Edit Tool.- JobType type JobTypeEnum - type string with restriction - enum { 'JOBTYPE-UNKNOWN', 'JOBTYPE-PLAYOUT', 'JOBTYPE-FINALIZE', 'JOBTYPE-INGEST', 'JOBTYPE-DISPLAY' }
Output:JobStartResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type JobStartResponse- JobID type string
-
ProjectClose
Description:Closes the currently loaded CLIPSTER project.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectClose (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectClose[ForceSave] --- When set to
true
, the project will be saved automatically before it is closed. When set tofalse
, the project will be closed without saving.- ForceSave type boolean
Output:ProjectCloseResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectCloseResponse- ProjectLocationURL type string
-
ProjectGet
Description:Returns the specified project as a data string.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectGet (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectGet[ProjectLocationURL] --- The location and file name of the project that should be returned (e.g. file:///V:/video/some_file.cp).
- ProjectLocationURL type anyURI
Output:ProjectGetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectGetResponse- ProjectData type string
-
ProjectLoad
Description:Loads a CLIPSTER project file either by specifying an existing project on the SOAP client or by providing a complete *.cp project (valid for the SOAP client) as an XML string.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectLoad (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectLoad[ProjectLocationURL] --- The location and file name of either the project to load or for the XML string to be saved if [ProjectContent] is provided (e.g. file:///V:/video/some_file.cp).
[ProjectContent] --- The content of a complete CLIPSTER project file as an XML string.
[ForceLoad] --- Obsolete. Leave empty.
- ProjectLocationURL type anyURI
- ProjectContent - optional; type string
- ForceLoad - optional; type boolean
Output:ProjectLoadResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectLoadResponse- ProjectLocationURL type string
-
ProjectNameGet
Description:Returns the file name and path of the current project file (or an empty string if no project is loaded).Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectNameGet (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectNameGetNo parameters.Output:ProjectNameGetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectNameGetResponse
- FilePath type string
-
ProjectPropertyGet
Description:This command is experimental. It returns a property of the currently loaded project.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectPropertyGet (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectPropertyGet[Context] --- Determines the context (e.g. software module) from which to retrieve the property.
CONTEXT-EDITMODE
gets the property currently set in the Edit Tool,CONTEXT-IOMODE
the one set in the I/O Tool andCONTEXT-FINALIZE
the one set for a finalizing.[Property] --- The type of property that should be retrieved.
PROPERTY-RASTER
gets the video raster of the specified context.- Context type ContextEnum - type string with restriction - enum { 'CONTEXT-UNKNOWN', 'CONTEXT-EDITMODE', 'CONTEXT-IOMODE', 'CONTEXT-FINALIZE' }
- Property type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
Output:ProjectPropertyGetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectPropertyGetResponse- PropertyType type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
- PropertyValue type string
-
ProjectPropertySet
Description:This command is experimental. It sets a property for the currently loaded project.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:ProjectPropertySet (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectPropertySet[Context] --- Determines the context (e.g. software module) where to set the property.
CONTEXT-EDITMODE
sets the property for the Edit Tool,CONTEXT-IOMODE
for the I/O Tool andCONTEXT-FINALIZE
for a finalizing.[Property] --- The type of property that should be set.
[Parameter] --- The value for the property.
PROPERTY-RASTER
sets the video raster for the specified context.- Context type ContextEnum - type string with restriction - enum { 'CONTEXT-UNKNOWN', 'CONTEXT-EDITMODE', 'CONTEXT-IOMODE', 'CONTEXT-FINALIZE' }
- Property type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
- Parameter type string
Output:ProjectPropertySetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type ProjectPropertySetResponse -
SystemGetHandles
Description:Returns the current handle as well as its properties.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemGetHandles (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetHandlesNo parameters.Output:SystemGetHandlesResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetHandlesResponse
- HandleItemList - optional, unbounded; type
HandleItem
- Username type string
- IpAddress type string
- TimeIssuing type dateTime
- TimeExpiration type dateTime
- HandleItemList - optional, unbounded; type
HandleItem
-
SystemGetLastMessages
Description:When controlling a CLIPSTER application via web service, message boxes by the software on the SOAP client are suppressed normally. This command returns the messages (such as information, warnings or criticals) that occurred during the lifetime of a project.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemGetLastMessages (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetLastMessagesNo parameters.Output:SystemGetLastMessagesResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetLastMessagesResponse
- SystemMessageList - optional, unbounded; type
SystemMessage
- SystemMessageType type SystemMessageTypeEnum - type string with restriction - enum { 'SYSTEMMESSAGE-UNKNOWN', 'SYSTEMMESSAGE-NONE', 'SYSTEMMESSAGE-INFO', 'SYSTEMMESSAGE-QUESTION', 'SYSTEMMESSAGE-WARNING', 'SYSTEMMESSAGE-CRITICAL' }
- Caption type string
- Text type string
- Time type dateTime
- JobID type string
- ActionTaken type string
- SystemMessageList - optional, unbounded; type
SystemMessage
-
SystemGetStatus
Description:Returns the current status of the CLIPSTER application.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemGetStatus (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetStatusNo parameters.Output:SystemGetStatusResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemGetStatusResponse
- SystemStatus type SystemStatusTypeEnum - type string with restriction - enum { 'SYSTEMSTATUS-UNKNOWN', 'SYSTEMSTATUS-IDLE', 'SYSTEMSTATUS-FINALIZE', 'SYSTEMSTATUS-PLAYOUT', 'SYSTEMSTATUS-INGEST', 'SYSTEMSTATUS-PROJECTLOAD', 'SYSTEMSTATUS-DISPLAY' }
-
SystemReleaseHandle
Description:Releases the handle for the CLIPSTER application. Then the handle will be void.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemReleaseHandle (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemReleaseHandleNo parameters.Output:SystemReleaseHandleResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemReleaseHandleResponse
- Handle type string
-
SystemRenewHandle
Description:Sets a new lifetime for the handle.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemRenewHandle (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemRenewHandle[Username] --- The Name of the user that renews the handle.
[Lifetime] --- The time in seconds that the handle should be valid. Zero (0) (default) means no expiration.
- Username - optional; type string
- Lifetime - optional; type int
Output:SystemRenewHandleResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemRenewHandleResponse- Handle type string
- Username type string
- TimeExpiration type dateTime
-
SystemRequestHandle
Description:Most commands require a handle that has to be passed as a header element in subsequent calls to the web service. This command requests a handle from the CLIPSTER application providing exclusive access to control commands of the web service.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:SystemRequestHandle (SOAP:body, use = literal, part = Security)Source codeparameters type SystemRequestHandle[Username] --- The Name of the user that requests the handle.
[Lifetime] --- The time in seconds that the requested handle should be valid. Zero (0) (default) means no expiration.
[ValidationCheckInterval] --- The interval in seconds in which the web service will check for a usage of the handle. The handle must be used at least once in the specified time to keep it valid. Zero (0) (default) means no validity check.
- Username - optional; type string
- Lifetime - optional; type int
- ValidationCheckInterval - optional; type int
Output:SystemRequestHandleResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type SystemRequestHandleResponse- Handle type string
- Username type string
- TimeIssuing type dateTime
- TimeExpiration type dateTime
-
TCPCommandWrapper
Description:This command allows to send encapsulated XML commands to the remote controlled CLIPSTER system.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:TCPCommandWrapper (SOAP:body, use = literal, part = Handle)Source codeparameters type TCPCommandWrapper[Command] --- container for TCP command interface.
- Context type string
- Command type string
- ParameterList - optional, unbounded; type
CommandParameter
- Name type string
- Value type string
Output:TCPCommandWrapperResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type TCPCommandWrapperResponse[ParameterList] --- A list of name value pairs of the resonse of the TCP Command Interface.- ParameterList - optional, unbounded; type
CommandParameter
- Name type string
- Value type string
-
TimelineMarkerPositionGet
Description:Service definition of function __cws__TimelineMarkerPositionGetOperation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:TimelineMarkerPositionGet (SOAP:body, use = literal, part = Handle)Source codeparameters type TimelineMarkerPositionGet[Context] ---Output:TimelineMarkerPositionGetResponse (SOAP:body, use = literal, part = Handle)Source codeparameters type TimelineMarkerPositionGetResponse
- MarkerPosition - optional, unbounded; type long
Port type DvsClipsterWebservicePortType Source code
WSDL source code
Imported Schema exc-c14n.xsd
Imported Schema oasis-200401-wss-wssecurity-utility-1.0.xsd
Imported Schema xmldsig-core-schema.xsd
Imported Schema oasis-200401-wss-wssecurity-secext-1.0.xsd
Imported Schema .xsd
Imported Schema exc-c14n.xsd
Imported Schema oasis-200401-wss-wssecurity-utility-1.0.xsd
Imported Schema xmldsig-core-schema.xsd
Imported Schema oasis-200401-wss-wssecurity-secext-1.0.xsd
Imported Schema .xsd
About this Page
version 3.1.02,
author tomi vanek,
with modifications made by DVS Digital Video Systems AG.
The engine processed the WSDL in XSLT 2.0 compliant mode.