porttype DocumentService
A service for manipulating documents.

operations |
createDocument Creates a document in the Document Store, within the folder of the specified owner (e.g. case object)
input | service:createDocumentRequest Request message. Contains document content (or URL for) and other context data.
output | service:createDocumentResponse Response message. Contains a new document reference.
fault | service:ownerReferenceFault If the folder owner (e.g. case reference) was not valid.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
getDocumentMetadata Returns document metadata, given a document reference (e.g. name etc)
input | service:getDocumentMetadataRequest Request message.
output | service:getDocumentMetadataResponse Response message.
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
getDocumentContent Retrieves the binary content of the specified document
input | service:getDocumentContentRequest Request message.
output | service:getDocumentContentResponse Response message.
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
deleteDocument Deletes the specified document
input | service:deleteDocumentRequest Request message.
output | service:deleteDocumentResponse Response message.
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
moveDocument Moves an existing document from one folder to another
input | service:moveDocumentRequest Request message.
output | service:moveDocumentResponse Response message.
fault | service:ownerReferenceFault If the folder owner (e.g. case reference) was not valid.
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
linkDocument Links an existing document to a folder without removing it from its existing containing folder(s)
input | service:linkDocumentRequest Request message.
output | service:linkDocumentResponse Response message.
fault | service:ownerReferenceFault
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
unlinkDocument Unlinks a document from a folder
input | service:unlinkDocumentRequest Request message.
output | service:unlinkDocumentResponse Response message.
fault | service:ownerReferenceFault If the folder owner (e.g. case reference) was not valid.
fault | service:documentReferenceFault If the provided document reference is of an invalid format, or does not correspond to an existing document.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
findDocuments Finds documents that belong to a given owner, constrained by either name or a query string
input | service:findDocumentsRequest Request message.
output | service:findDocumentsResponse Response message.
fault | service:ownerReferenceFault If the document owner (e.g. case reference) was not valid.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
getFolderContent Obtains the contents (documents and/or nested folders) for a given folder, or the folder of a given owner
input | service:getFolderContentRequest Request message.
output | service:getFolderContentResponse Response message.
fault | service:ownerReferenceFault If the folder owner (e.g. case reference) was not valid.
fault | service:folderReferenceFault If the provided folder reference is of an invalid format, or does not correspond to an existing folder.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
deleteOrphanedFolders Deletes any folder for which the owning object has ceased to exist
input | service:deleteOrphanedFoldersRequest Request message.
output | service:deleteOrphanedFoldersResponse Response message.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
getRepositoryInfo Obtains information about the repository and its capabilities
input | service:getRepositoryInfoRequest Request message.
output | service:getRepositoryInfoResponse Response message.
fault | service:invalidDataFault If an input parameter (apart from references) was invalid.
fault | service:documentStoreAccessFault If a problem occurs accessing the Document Store repository.
fault | service:securityFault If the caller lacks the security rights to perform the operation
fault | service:internalServiceFault If the service malfunctions (due to a reason other than bad data from the caller)
used by |
binding DocumentService_EP
source |
    <wsdl:portType name="DocumentService">
      <wsdl:documentation>A service for manipulating documents.</wsdl:documentation>
      <wsdl:operation name="createDocument">
        <wsdl:documentation>Creates a document in the Document Store, within the folder of the specified owner (e.g. case object)</wsdl:documentation>
        <wsdl:input name="createDocumentRequest" message="service:createDocumentRequest">
          <wsdl:documentation>Request message. Contains document content (or URL for) and other context data.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="createDocumentResponse" message="service:createDocumentResponse">
          <wsdl:documentation>Response message. Contains a new document reference.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault">
          <wsdl:documentation>If the folder owner (e.g. case reference) was not valid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="getDocumentMetadata">
        <wsdl:documentation>Returns document metadata, given a document reference (e.g. name etc)</wsdl:documentation>
        <wsdl:input name="getDocumentMetadataRequest" message="service:getDocumentMetadataRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="getDocumentMetadataResponse" message="service:getDocumentMetadataResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="getDocumentContent">
        <wsdl:documentation>Retrieves the binary content of the specified document</wsdl:documentation>
        <wsdl:input name="getDocumentContentRequest" message="service:getDocumentContentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="getDocumentContentResponse" message="service:getDocumentContentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="deleteDocument">
        <wsdl:documentation>Deletes the specified document</wsdl:documentation>
        <wsdl:input name="deleteDocumentRequest" message="service:deleteDocumentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="deleteDocumentResponse" message="service:deleteDocumentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="moveDocument">
        <wsdl:documentation>Moves an existing document from one folder to another</wsdl:documentation>
        <wsdl:input name="moveDocumentRequest" message="service:moveDocumentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="moveDocumentResponse" message="service:moveDocumentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault">
          <wsdl:documentation>If the folder owner (e.g. case reference) was not valid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="linkDocument">
        <wsdl:documentation>Links an existing document to a folder without removing it from its existing containing folder(s)</wsdl:documentation>
        <wsdl:input name="linkDocumentRequest" message="service:linkDocumentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="linkDocumentResponse" message="service:linkDocumentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault"/>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="unlinkDocument">
        <wsdl:documentation>Unlinks a document from a folder</wsdl:documentation>
        <wsdl:input name="unlinkDocumentRequest" message="service:unlinkDocumentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="unlinkDocumentResponse" message="service:unlinkDocumentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault">
          <wsdl:documentation>If the folder owner (e.g. case reference) was not valid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentReferenceFault" message="service:documentReferenceFault">
          <wsdl:documentation>If the provided document reference is of an invalid format, or does not correspond to an existing document.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="findDocuments">
        <wsdl:documentation>Finds documents that belong to a given owner, constrained by either name or a query string </wsdl:documentation>
        <wsdl:input name="findDocumentsRequest" message="service:findDocumentsRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="findDocumentsResponse" message="service:findDocumentsResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <!-- Only possible if ECM facade throws specific exception for bad CMISQL -->
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault">
          <wsdl:documentation>If the document owner (e.g. case reference) was not valid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="getFolderContent">
        <wsdl:documentation>Obtains the contents (documents and/or nested folders) for a given folder, or the folder of a given owner</wsdl:documentation>
        <wsdl:input name="getFolderContentRequest" message="service:getFolderContentRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="getFolderContentResponse" message="service:getFolderContentResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="OwnerReferenceFault" message="service:ownerReferenceFault">
          <wsdl:documentation>If the folder owner (e.g. case reference) was not valid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="FolderReferenceFault" message="service:folderReferenceFault">
          <wsdl:documentation>If the provided folder reference is of an invalid format, or does not correspond to an existing folder.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="deleteOrphanedFolders">
        <wsdl:documentation>Deletes any folder for which the owning object has ceased to exist</wsdl:documentation>
        <wsdl:input name="deleteOrphanedFoldersRequest" message="service:deleteOrphanedFoldersRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="deleteOrphanedFoldersResponse" message="service:deleteOrphanedFoldersResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
      <wsdl:operation name="getRepositoryInfo">
        <wsdl:documentation>Obtains information about the repository and its capabilities</wsdl:documentation>
        <wsdl:input name="getRepositoryInfoRequest" message="service:getRepositoryInfoRequest">
          <wsdl:documentation>Request message.</wsdl:documentation>
        </wsdl:input>
        <wsdl:output name="getRepositoryInfoResponse" message="service:getRepositoryInfoResponse">
          <wsdl:documentation>Response message.</wsdl:documentation>
        </wsdl:output>
        <wsdl:fault name="InvalidDataFault" message="service:invalidDataFault">
          <wsdl:documentation>If an input parameter (apart from references) was invalid.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="DocumentStoreAccessFault" message="service:documentStoreAccessFault">
          <wsdl:documentation>If a problem occurs accessing the Document Store repository.</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="SecurityFault" message="service:securityFault">
          <wsdl:documentation>If the caller lacks the security rights to perform the operation</wsdl:documentation>
        </wsdl:fault>
        <wsdl:fault name="InternalServiceFault" message="service:internalServiceFault">
          <wsdl:documentation>If the service malfunctions (due to a reason other than bad data from the caller)</wsdl:documentation>
        </wsdl:fault>
      </wsdl:operation>
    </wsdl:portType>

WSDL documentation generated by XMLSpy WSDL Editor http://www.altova.com/xmlspy