ImaIntegrationService

The ImaIntegrationService is a SOAP web service and provides requests to archive, update and retrieve documents but also to execute queries and to manage configuration items. The requests listed in the table below are used in the context of the Content Services for E-Mail:

Request

Description

createDocument

Archives a new document in ImageMaster and returns the document ID and revision ID.

getLatestRevision

Retrieves the latest revision of the document for a given document ID.

checkoutLatestRevision

Locks the document and creates a working copy of the document's latest revision for editing.

cancelCheckout

Cancels a check-out operation that is in progress and removes the corresponding working copy.

updateAttributes

Modifies the metadata set of the working copy revision. The provided attribute values replace the attribute values for the corresponding attributes in the working copy revision. That is, only the provided attributes will be altered, unmentioned attributes remain untouched.

checkinRevision

Turns the working copy revision into a regular and permanent revision. This checked in revision becomes the new latest revision of the corresponding document. If the checkinOperator is REPLACE_CHECKED_OUT_REVISION, the request deletes the checked-out (locked) revision after the checkin.

query

Contains operations to search efficiently using structured queries. Executes a query (based on RAQL) to search for documents, revisions or other entities of the Integration Service.

addPlan

Adds a retention plan to a document. The plan is executed synchronously until it reaches a waiting or finished state.

abortPlan

Aborts the execution of a plan. If the plan is already aborted or finished, the request succeeds.

removePlan

Removes a retention plan from its document. The plan must either be aborted or finished. Plans that are part of a hold must be removed using the removeHold operation.