Package com.collabnet.ce.soap60.webservices.docman

Class DocumentAppSoap

  • All Implemented Interfaces:
    IDocumentAppSoap
    public class DocumentAppSoap
extends WebService
implements IDocumentAppSoap
    Provides SOAP web service for document manager application.

    Change History
    Version 18.1
    • Modified to ignore the time portion of the custom Date field's value.
    Version 17.1
    • addTextField: New method to add a custom text field to documents.
    • addSingleSelectChildField: New method to add a custom single select field to documents.
    • addSingleSelectField: New method to add a custom single select field to documents.
    • addMultiSelectField: New method to add a custom multi select field to documents.
    • addUserSelectField: New method to add a custom User selection field to documents.
    • addDateField: New method to add a custom Date field to documents.
    • getFields: New method to get the custom/flex-fields associated with a specific document root folder.
    • setField: New method to set a custom/flex-field that is associated with a specific document root folder.
    • deleteField: New method to delete a custom/flex-field.
    • addSeparator: New method to add a separator to a document root folder.
    • deleteSeparator: New method to delete a separator of a document root folder layout.
    • getOrderedDocumentFields: New method to get the ordered list of all custom/flex-fields and
      separators associated with the given project's document root folder.
    • reorderDocumentFields: New method to reorder the list of custom/flex-fields and separators.
    • createDocument3 New method, to support create document with flex fields
    • createDocumentWithUrl3 New method, to support create document with url, flex fields
    • setDocumentData3 New method, to support create update with flex fields
    • setDocumentDataWithAssociation3 New method, to support update document with association, flex fields
    • moveDocument3 New method, to support move document with flex fields
    • getDocumentData3 New method to support get document data with flex fields
    • getDocumentList3 New method to list all documents within a document folder.
    • findDocuments3 New method to find a list of documents matching a search string.
    Version 8.1
    • getDocumentVersions: New method to list all the versions of a document.
    • deleteDocumentByVersions: New method to delete particular version(s) of a document.
    • createDocument2: New method to create a document with createDownloadRestricted and allowForceUnlock
      attributes.
    • createDocumentWithUrl2: New method to create a document for a URL with createDownloadRestricted and
      allowForceUnlock attributes.
    • getDocumentData2: New method to get the document data.
    • setDocumentData2: New method to set the document data.
    • setDocumentDataWithAssociation2: New method to set the document data with association.
    • getDocumentList2: New method to get the list of all documents within a document folder.
    • findDocuments2: New method to find a list of documents matching a search string.
    • moveDocument2: New method to move a document to a specified target folder.
    Version 4.4
    • setDocumentDataWithUrl: Removed in 4.4. Use DocumentSoapDO.setFileUrl and setDocumentData instead.
    • getDocumentFileUrl: Removed in 4.4. Use getDocumentData and call DocumentSoapDO.getFileUrl instead.
    Version 6.2
    • getDocumentFolderList: No Change in the parameters, however now the api returns the following :
      a)When project id is passed with recursive = false, the user obtains only the first matching document folders in the tree from root for which the user has persmission.
      b)When project id is passed with recursive = true, the user obtains all the document folders and descendants for which the user has permission.
      c)When a document folder id is passed with recursive = false, the first matching child folders in the tree from the passed folder for which the user has permission are retrieved.(Not the passed folder)
      d)When a document folder id is passed with recursive = true, the children folders and descendants which the user has permission are retrieved.(Not the passed folder)
      (In Earlier version [i.e prior to CTF6.2] when project id was passed the api would return the document root folder, the current api would return root folder only if the user has permission to the root folder).
    Since:
    4.1