Web Service: DvsSpycerWebservice

Port type DvsSpycerWebservicePortType Source code

1. ContentGetProperties
   Source code
   Description:
   Returns the properties (metadata) of a file or file sequence.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   ContentGetProperties (SOAP:body, use = literal, part = Security)Source code
   parameters type ContentGetProperties

   [ContentURL] --- The path and file name to content on a system in the notation {//<system>}/<path>/<file name>. For a file sequence the frame numbering should be specified in C notation (as e.g. in Hollywood_%05d.dpx).

   • ContentURL type anyURI
   Output:
   ContentGetPropertiesResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type ContentGetPropertiesResponse

   • ContentProperties type ContentProperties
     • ParentPath type string
     • Content type Content
       • ID type string
       • Type type ContentTypeEnum - type string with restriction - enum { 'CONTENT-UNKNOWN', 'CONTENT-VIDEO', 'CONTENT-AUDIO', 'CONTENT-CONTAINER', 'CONTENT-STILL' }
       • Metadata type ContentMetadata
         • Name type string
         • Path type string
         • Size type unsignedLong
         • Format type string
         • LastModified type dateTime
         • Defragmented type unsignedInt
         • Owner type string
         • Peer type string
         • Duration type string
         • FileCount type unsignedInt
         • Width type unsignedInt
         • Height type unsignedInt
         • Resolution type string
         • FrameRate type float
         • FrameCount type unsignedInt
         • FirstFrame type unsignedInt
         • LastFrame type unsignedInt
         • FieldMode type FieldModeEnum - type string with restriction - enum { 'FIELDMODE-UNKNOWN', 'FIELDMODE-PROGRESSIVE', 'FIELDMODE-INTERLACED', 'FIELDMODE-SEGMENTEDFRAME' }
         • FieldDominance type FieldDominanceEnum - type string with restriction - enum { 'FIELDDOMINANCE-UNKNOWN', 'FIELDDOMINANCE-ODD', 'FIELDDOMINANCE-EVEN' }
         • Range type RangeEnum - type string with restriction - enum { 'RANGE-UNKNOWN', 'RANGE-FULL', 'RANGE-HEAD' }
         • Gamma type GammaEnum - type string with restriction - enum { 'GAMMA-UNKNOWN', 'GAMMA-SMPTE125CCIR601', 'GAMMA-SMPTE274CCIR709', 'GAMMA-SMPTE240' }
         • ColorMode type ColorModeEnum - type string with restriction - enum { 'COLORMODE-UNKOWN', 'COLORMODE-RGB', 'COLORMODE-RGBA', 'COLORMODE-YUV', 'COLORMODE-YUVA', 'COLORMODE-XYZ' }
         • Sampling type unsignedInt
         • ColorDepth type unsignedInt
         • AlphaDepth type unsignedInt
         • ScreenWidth type unsignedInt
         • ScreenHeight type unsignedInt
         • AspectX type unsignedInt
         • AspectY type unsignedInt
         • AspectRatio type double
         • PixelRatio type double
         • VideoCodec type string
         • StartTimecode type string
         • EndTimecode type string
         • StartKeycode type string
         • EndKeycode type string
         • DropFrame type boolean
         • TcFrameRate type unsignedInt
         • ReelName type string
         • InputDeviceName type string
         • FilmGauge type string
         • SequenceInfoFpF type unsignedInt
         • AudioChannels type unsignedInt
         • AudioResolution type unsignedInt
         • AudioSamplingRate type unsignedInt
         • AudioSamples type unsignedLong
         • AudioCodec type string
         • ProductionCompany type string
         • ProductionTitle type string
         • ProductionDate type dateTime
         • ProductionCameraId type string
         • ProductionScene type string
         • ProductionShot type string
         • ProductionCameraReel type string
         • ProductionSoundReel type string
         • ProductionLabReel type string
         • ProductionCircleTake type boolean
         • ProductionScanFacility type string
         • ProductionOperator type string
         • ProductionScannerId type string
         • ProductionTransferDate type dateTime
         • ProductionDescription type string
         • ProductionComment type string
2. ContentSetProperties
   Source code
   Description:
   Currently this command provides no functionality. It will set the properties (metadata) of a file or file sequence. Only the production metadata can be set.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   ContentSetProperties (SOAP:body, use = literal, part = Security)Source code
   parameters type ContentSetProperties

   [ContentURL] --- The path and file name to content on a system in the notation {//<system>}/<path>/<file name>. For a file sequence the frame numbering should be specified in C notation (as e.g. in Hollywood_%05d.dpx).

   [NewMetadata] --- The metadata to be set.

   • ContentURL type string
   • NewMetadata type string
   Output:
   ContentSetPropertiesResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type ContentSetPropertiesResponse
3. FolderGetContent
   Source code
   Description:
   Returns the files stored in the specified folder and some of their metadata.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   FolderGetContent (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetContent

   [FolderURL] --- A path leading to a directory on a system in the notation {//<system>}/<path>/.

   • FolderURL type anyURI
   Output:
   FolderGetContentResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetContentResponse

   • FolderContent type FolderContent
     • ParentPath type string
     • FileList - optional, unbounded; type File
       • ID type string
       • Type type ContentTypeEnum - type string with restriction - enum { 'CONTENT-UNKNOWN', 'CONTENT-VIDEO', 'CONTENT-AUDIO', 'CONTENT-CONTAINER', 'CONTENT-STILL' }
       • Metadata type FileMetadata
         • Name type string
         • Path type string
         • Size type unsignedLong
         • Format type string
         • LastModified type dateTime
         • Defragmented type unsignedInt
         • Owner type string
         • Peer type string
4. FolderGetProperties
   Source code
   Description:
   Returns information about the specified folder, such as its size and the number of files that are stored in it.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   FolderGetProperties (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetProperties

   [FolderURL] --- A path leading to a directory on a system in the notation {//<system>}/<path>/.

   [Target] --- TARGET-DB (default) gets the data from the Spycer database if available. If it is not available, TARGET-FS will be performed. TARGET-FS gets the data from the file system. Depending on the amount of data in the folder, it may take some time to respond.

   [Timeout] --- The time in seconds that the web service will wait for an answer. Zero (0) (default) means no timeout.

   • FolderURL type anyURI
   • Target - optional; type PropertiesTarget - type string with restriction - enum { 'TARGET-UNKNOWN', 'TARGET-DB', 'TARGET-FS' }
   • Timeout - optional; type unsignedInt
   Output:
   FolderGetPropertiesResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetPropertiesResponse

   • FolderProperties type FolderProperties
     • DiskSize type unsignedLong
     • DiskFreeSize type unsignedLong
     • DiskFileSystem type string
     • DiskName type string
     • Size type unsignedLong
     • FolderCount type unsignedLong
     • FileCount type unsignedLong
     • Created type dateTime
     • LastModified type dateTime
     • Owner type string
5. FolderGetSubfolders
   Source code
   Description:
   Returns the subfolders available in the specified folder and some of their properties.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   FolderGetSubfolders (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetSubfolders

   [FolderURL] --- A path leading to a directory on a system in the notation {//<system>}/<path>/.

   • FolderURL type anyURI
   Output:
   FolderGetSubfoldersResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type FolderGetSubfoldersResponse

   • FolderSubfolders type FolderSubfolders
     • ParentPath type string
     • FolderList - optional, unbounded; type Folder
       • ID type string
       • Name type string
       • Path type string
       • SubfolderCount type unsignedInt
       • ContentCount type unsignedInt
       • FileSystem type string
       • Status type string
       • Owner type string
6. JobControl
   Source code
   Description:
   Pauses, resumes or cancels the specified job.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   JobControl (SOAP:body, use = literal, part = Security)Source code
   parameters type JobControl

   [JobID] --- The ID of the job.

   [JobControlType] --- The action that should be performed.

   • JobID type string
   • JobControlType type JobControlTypeEnum - type string with restriction - enum { 'JOBCONTROL-UNKNOWN', 'JOBCONTROL-CANCEL', 'JOBCONTROL-PAUSE', 'JOBCONTROL-RESUME' }
   Output:
   JobControlResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type JobControlResponse
7. JobCopy
   Source code
   Description:
   Copies the specified file or folder from one location to another.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   JobCopy (SOAP:body, use = literal, part = Security)Source code
   parameters type JobCopy

   [FromURL] --- The source directory/file. Either a path or a path together with a file name in the notation {//<system>}/<path>/{<file name>}.

   [ToURL] --- The target directory. A path leading to a directory on a system in the notation {//<system>}/<path>/.

   [Overwrite] --- When set to false (default), already existing data will not be overwritten. In such a case, however, the job will not be terminated but paused only and must be cancelled manually. When set to true, already existing data will be overwritten if a file with the same name exists at the target location.

   • FromURL type anyURI
   • ToURL type anyURI
   • Overwrite - optional; type boolean
   Output:
   JobCopyResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type JobCopyResponse

   • JobID type string
8. JobDefrag
   Source code
   Description:
   Defragments the specified drive, directory, file, or file sequence.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   JobDefrag (SOAP:body, use = literal, part = Security)Source code
   parameters type JobDefrag

   [TargetURL] --- The location/data to be defragmented. Either a path or a path together with a file name in the notation {//<system>}/<path>/{<file name>}. For a file sequence the frame numbering should be specified in C notation (as e.g. in Hollywood_%05d.dpx).

   • TargetURL type anyURI
   Output:
   JobDefragResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type JobDefragResponse

   • JobID type string
9. JobDelete
   Source code
   Description:
   Deletes the specified file or folder physically from the storage (without undo or recycle bin).
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   JobDelete (SOAP:body, use = literal, part = Security)Source code
   parameters type JobDelete

   [TargetURL] --- The directory/file that should be deleted. Either a path or a path together with a file name in the notation {//<system>}/<path>/{<file name>}.

   • TargetURL type anyURI
   Output:
   JobDeleteResponse (SOAP:body, use = literal, part = Security)Source code
   parameters type JobDeleteResponse

   • JobID type string
10. JobGetIDs
    Source code
    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 = Security)Source code
    parameters type JobGetIDs

    No parameters.
    Output:
    JobGetIDsResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobGetIDsResponse

    Peer IDs will be returned as attributes in the response XML.

    • JobIDList - optional, unbounded; type Job
      • PeerID - required; type string
11. JobGetStatus
    Source code
    Description:
    Gets 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 = Security)Source code
    parameters type JobGetStatus

    [JobID] --- The ID of the job.

    • JobID type string
    Output:
    JobGetStatusResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobGetStatusResponse

    • JobStatus type JobStatus
      • ID type string
      • Type type JobTypeEnum - type string with restriction - enum { 'JOBTYPE-UNKNOWN', 'JOBTYPE-COPY', 'JOBTYPE-DELETE', 'JOBTYPE-MOVE', 'JOBTYPE-RENAME', 'JOBTYPE-MAKEFOLDER', 'JOBTYPE-DEFRAG', 'JOBTYPE-SCAN', 'JOBTYPE-CANCELJOBS', 'JOBTYPE-PAUSEJOBS', 'JOBTYPE-RESUMEJOBS', 'JOBTYPE-CONVERT', 'JOBTYPE-METAEDIT', 'JOBTYPE-PROXY', 'JOBTYPE-SEARCH' }
      • CreatorPeerName type string
      • CreatorPeerID type string
      • CreatorUserName type string
      • SrcPeerName type string
      • SrcPeerID type string
      • SrcPath type string
      • DestPeerName type string
      • DestPeerID type string
      • DestPath type string
      • Status type JobStatusEnum - type string with restriction - enum { 'JOBSTATUS-UNKNOWN', 'JOBSTATUS-PENDING', 'JOBSTATUS-RUNNING', 'JOBSTATUS-PAUSED', 'JOBSTATUS-INTERRUPTED', 'JOBSTATUS-FINISHED', 'JOBSTATUS-FAILED', 'JOBSTATUS-CANCELED' }
      • Progress type int
      • TimeRemaining type string
      • TimeCreated type dateTime
      • TimeStart type dateTime
      • TimeFinished type dateTime
      • Additional type string
      • LastError type string
12. JobMakeFolder
    Source code
    Description:
    Creates a new folder at the specified location.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobMakeFolder (SOAP:body, use = literal, part = Security)Source code
    parameters type JobMakeFolder

    [TargetURL] --- A path leading to a directory on a system in the notation {//<system>}/<path>/.

    [NewName] --- The name of the new folder.

    • TargetURL type anyURI
    • NewName type string
    Output:
    JobMakeFolderResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobMakeFolderResponse

    • JobID type string
13. JobMove
    Source code
    Description:
    Moves the specified file or folder from one location to another.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobMove (SOAP:body, use = literal, part = Security)Source code
    parameters type JobMove

    [FromURL] --- The source directory/file. Either a path or a path together with a file name in the notation {//<system>}/<path>/{<file name>}.

    [ToURL] --- The target directory. A path leading to a directory on a system in the notation {//<system>}/<path>/.

    [Overwrite] --- When set to false (default), already existing data will not be overwritten. In such a case, however, the job will not be terminated but paused only and must be cancelled manually. When set to true, already existing data will be overwritten if a file with the same name exists at the target location.

    • FromURL type anyURI
    • ToURL type anyURI
    • Overwrite - optional; type boolean
    Output:
    JobMoveResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobMoveResponse

    • JobID type string
14. JobRename
    Source code
    Description:
    Renames the specified folder, file or file sequence.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobRename (SOAP:body, use = literal, part = Security)Source code
    parameters type JobRename

    [TargetURL] --- The directory/file to be renamed. Either a path or a path together with a file name in the notation {//<system>}/<path>/{<file name>}. For a file sequence the frame numbering should be specified in C notation (as e.g. in Hollywood_%05d.dpx).

    [NewName] --- The new name for the folder/file.

    • TargetURL type anyURI
    • NewName type string
    Output:
    JobRenameResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobRenameResponse

    • JobID type string
15. JobRescan
    Source code
    Description:
    Initiates a scan of the specified folder.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobRescan (SOAP:body, use = literal, part = Security)Source code
    parameters type JobRescan

    [TargetURL] --- A path leading to a directory on a system in the notation {//<system>}/<path>/.

    • TargetURL type anyURI
    Output:
    JobRescanResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobRescanResponse

    • JobID type string
16. JobSearch
    Source code
    Description:
    Perfoms a search for files on the specified peer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobSearch (SOAP:body, use = literal, part = Security)Source code
    parameters type JobSearch

    [Peer] --- Peer identifier, e.g. its IP address, DNS name or peer ID. If no peer is specified, the search will be made on the SOAP client. If NETWORK is specified, the complete SpycerNet will be searched.

    [Query] --- The parameters for the search. They have to be specified in XML:
    <query type="search"><condition><con meta="[searchtype]" op="[operator]" value="[string]"/></condition></query>
    [searchtype]: The type of the search (e.g. FileName, MissingFrames, ProductionDate, etc.).
    [operator]: HTML entity for less than, HTML entity for greater than, or =, as well as their combinations. For some search types != can be used. For string searches use =.
    [string]: The search string, use %% as wildcard.
    An AND search can be performed by specifying further <condition> elements in the <query> tag, an OR search can be performed by specifying further <con> elements in a <condition> tag.

    [MaxResults] --- The maximum number of search results that will be returned. Zero (0) (default) means all results.

    [Timeout] --- The time in seconds that the web service will wait for an answer. Zero (0) (default) means no timeout.

    • Peer - optional; type string
    • Query type string
    • MaxResults - optional; type unsignedInt
    • Timeout - optional; type unsignedInt
    Output:
    JobSearchResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobSearchResponse

    • SearchState type SearchStateEnum - type string with restriction - enum { 'SEARCHSTATE-UNKNOWN', 'SEARCHSTATE-COMPLETE', 'SEARCHSTATE-INCOMPLETE' }
    • Query type string
    • TotalResultsAvailable type unsignedInt
    • TotalResultsReturned type unsignedInt
    • FileList - optional, unbounded; type File
      • ID type string
      • Type type ContentTypeEnum - type string with restriction - enum { 'CONTENT-UNKNOWN', 'CONTENT-VIDEO', 'CONTENT-AUDIO', 'CONTENT-CONTAINER', 'CONTENT-STILL' }
      • Metadata type FileMetadata
        • Name type string
        • Path type string
        • Size type unsignedLong
        • Format type string
        • LastModified type dateTime
        • Defragmented type unsignedInt
        • Owner type string
        • Peer type string
17. JobSystemCall
    Source code
    Description:
    For DVS internal use only.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    JobSystemCall (SOAP:body, use = literal, part = Security)Source code
    parameters type JobSystemCall

    • Peer type string
    • Command type string
    Output:
    JobSystemCallResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type JobSystemCallResponse

    • JobID type string
18. PeerGetAll
    Source code
    Description:
    Returns all peers registered in the SpycerNet with their ID, host name and IP address.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    PeerGetAll (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetAll

    No parameters.
    Output:
    PeerGetAllResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetAllResponse

    • PeerList - optional, unbounded; type Peer
      • ID type string
      • HostName type string
      • IpAddress type string
19. PeerGetProperties
    Source code
    Description:
    Returns information about a peer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    PeerGetProperties (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetProperties

    [Peer] --- Peer identifier, e.g. its IP address, DNS name or peer ID. If no peer is specified, information about the SOAP client will be returned.

    • Peer - optional; type string
    Output:
    PeerGetPropertiesResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetPropertiesResponse

    The peer ID will be returned as an attribute in the response XML.

    • Info type PeerInfo
      • Uptime type string
      • Architecture type string
      • Cpu type string
      • Cores type unsignedShort
      • RAM type unsignedInt
      • OS type string
      • ProductVersion type string
      • ProductSpecial type string
      • IpAddress type string
      • User type string
      • PeerID - required; type string
20. PeerGetStatus
    Source code
    Description:
    Returns status information of a peer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    PeerGetStatus (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetStatus

    [Peer] --- Peer identifier, e.g. its IP address, DNS name or peer ID. If no peer is specified, the status information of the SOAP client will be returned.

    • Peer - optional; type string
    Output:
    PeerGetStatusResponse (SOAP:body, use = literal, part = Security)Source code
    parameters type PeerGetStatusResponse

    • State type StateEnum - type string with restriction - enum { 'STATE-UNKNOWN', 'STATE-ONLINE', 'STATE-OFFLINE' }

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 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

This page was generated by using wsdl-viewer.xsl,
version 3.1.02,
author tomi vanek,
with modifications made by DVS Digital Video Systems AG.

The generator was SAXON 9.1.0.8 from Saxonica XSLT engine.
The engine processed the WSDL in XSLT 2.0 compliant mode.

DVS Digital Video Systems AG
http://www.dvs.de
doku@dvs.de