Webservice: Archive

handles the archiving [Commercial editions only]

Index Method Request(s) Response Description
1 archiveFolder sid
folderId
comment
archiveFolder archives all the documents contained in a tree
2 archiveDocuments sid
docIds
comment
archives a set of documents
3 listArchivedDocs sid
folderId
listArchivedDocs lists the archived documents inside a folder
4 unarchiveDocuments sid
docIds
restores a set of archived documents

Method #1: archiveFolder

archives all the documents contained in a tree

Request

Name Type Required Multiple Description
     sid
String Y
     folderId
Long Y
     comment
String reason of this action

Response

Name Type Required Multiple Description
     archiveFolder
Long Y

Method #2: archiveDocuments

archives a set of documents

Request

Name Type Required Multiple Description
     sid
String Y
     docIds
Long Y Y ids of the documents to archive
     comment
String reason of this action

Method #3: listArchivedDocs

lists the archived documents inside a folder

Request

Name Type Required Multiple Description
     sid
String Y
     folderId
Long Y

Response

Name Type Required Multiple Description
     listArchivedDocs
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          published
Int If it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default -1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password

Method #4: unarchiveDocuments

restores a set of archived documents

Request

Name Type Required Multiple Description
     sid
String Y
     docIds
Long Y Y ids of the documents to restore