Webservice: Impex

handling of import/export archives

Index Method Request(s) Response Description
1 getArchiveIdByName sid
name
archiveId Retrieves the identifier of an existing archive
2 addDocumentToExportArchive sid
archiveId
docId
adds a document to an existing export archive
3 deleteExportArchive sid
archiveId
deletes an existing export archive
4 closeExportArchive sid
archiveId
closes an existing export archive
5 createExportArchive sid
name
description
archiveId creates a new export archive; returns the identifier of the newly created archive

Method #1: getArchiveIdByName

Retrieves the identifier of an existing archive

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     archiveId
Long Y

Method #2: addDocumentToExportArchive

adds a document to an existing export archive

Request

Name Type Required Multiple Description
     sid
String Y
     archiveId
Long Y
     docId
Long Y

Method #3: deleteExportArchive

deletes an existing export archive

Request

Name Type Required Multiple Description
     sid
String Y
     archiveId
Long Y

Method #4: closeExportArchive

closes an existing export archive

Request

Name Type Required Multiple Description
     sid
String Y
     archiveId
Long Y

Method #5: createExportArchive

creates a new export archive; returns the identifier of the newly created archive

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y
     description
String Y

Response

Name Type Required Multiple Description
     archiveId
Long Y