Web service references

The ImageMaster web service references for developers and system integrators provide a specification of the available methods, data objects and error codes in an ImageMaster Integration Service environment. The references are categorized by technology (SOAP or REST) and topics:

Day-to-day routine document management (create, read, update, and delete documents):

• [WS IS REST] – REST Integration Service reference

  • For everyday operations on documents like “create” and “retrieve”, the REST web services are recommended.

  • The REST web services will be maintained and optimized in the future.

  • Dedicated tutorials are available for the REST web services:

    • Java client for REST web service [Tutorial REST Java Client]

    • Multipart requests for REST web service [Tutorial REST Multipart Requests]

• Deprecated: [WS IS] – SOAP Integration Web Service Reference

  • Although the SOAP services in their current state remain supported, these will NOT be optimized or extended in the future.

  • If you install a new system, rather use the REST services instead.

• [WS AdminClient] – SOAP Administration Web Service Reference

  • These services are for system initialization, configuration, and administration.

  • The SOAP Administration services are not deprecated.

  • These must further be used for administration use cases.

  • There are no REST-based administration services that can replace these.

ImageMaster Business Process Management (Workflow Service):

• [WS BPM REST] – REST WorkflowService for BPM

ImageMaster Client services

• [WS Client REST] – REST Client (related to common services of WorkplaceClient / AdminClient)

ImageMaster Postbox (only in second release per year 9.x.2)

• [WS PB REST] – REST Postbox

Content Services for 3D Structures for download and export:

• [WS 3D REST] – REST Archive3dRest for download and export

Content Services for ERP (for SAP integration)

• [WS ERP REST] – REST (ERP ContentServer Service) for SAP

The following sections within this document provide related overviews:

• Document management services (day-to-day routine document management)

• System management services (administration, configuration, initialization)