Skip to main content

Webservices v2 - Knowledgebase / Autoform DM / Autoform DM General Information - Formpipe Support Portal

Webservices v2

Authors list

What is Webservices v2?

Webservices v2 is, like Webservices v1, a legacy service that operates using SOAP.

The service provides operations for searching and managing documents, as well as very rarely used facilities for importing documents and sending emails. It is used by the Autoform DM Client applications suite, BPM, and has also been used to build customer integrations in the past.

Why is it being removed?

As with Webservices v1, this service lacks the functionality and ease of use of the REST API. Additionally, it has not been actively developed for several product versions.

The service, which was previously part of DM, ensured the proper functioning of client applications and gave customers time to migrate using the REST API.

How can I tell if this affects me?

Any integration code that uses any of the following DM service URLs are affected:

{baseurl}/pdmwebsvc-v2/document

{baseurl}/pdmwebsvc-v2/search

{baseurl}/pdmwebsvc-v2/import

{baseurl}/pdmwebsvc-v2/email

{baseurl}/pdmwebsvc-v2.1/document

{baseurl}/pdmwebsvc-v2.1/search

{baseurl}/pdmwebsvc-v2.1/import

{baseurl}/pdmwebsvc-v2.1/emailx4sz#...............................\s

Usage in code is usually initiated using one or more of the above service URLs and appending ?wsdl to the end in order to access and parse the WSDL document.

What are my migration options?

A fully featured REST API provides everything needed to connect external systems and build effective integration solutions. Both Java and Javascript SDKs are available to help customers get started quickly and easily.

Common WSv2 operations and their REST API equivalents are listed below:

WSv2 Resource

WSv2 Operation

REST Resource

REST Operation

/search

GetDocument

/document-search

GET document-search/{name}

/search

GetDocuments

/document-search

GET document-search/{name}

WSv2 Resource

WSv2 Operation

REST Resource

REST Operation

/document

Create

/documents

POST /documents

/document

CreateOrUpdate

/documents

No direct equivalent

/document

GetById

/documents

GET /documents/by-id/{id}

/document

GetByCuk

/documents

GET /documents/by-cuk/{cuk}

/document

GetByIdAndRevision

/documents

GET /documents/by-id/{id}/{revision}

/document

Update

/documents

PUT /documents/by-id/{id} OR PUT /documents/by-cuk/{cuk}

/document

Hide

/documents

PUT /documents/by-id/{id} OR PUT /documents/by-cuk/{cuk}

/document

Unhide

/documents

PUT /documents/by-id/{id} OR PUT /documents/by-cuk/{cuk}

/document

Delete

/documents

DELETE /documents/by-id/{id} OR DELETE /documents/by-cuk/{cuk}

/search

The WSv2 operations GetDocument and GetDocuments allow you to search for and retrieve one or more documents. Using hints, line items, notes, and document-file can be obtained as a part of the response.

The immediate difference when using the REST API is that the /document-search resource allows you to search for and return only metadata. Using the revision and either ID or CUK values from the response, any additional document resources such as line-items, notes, or the file can be obtained via the REST /documents resource. For example, GET /documents/by-id/{id}/{revision}/file.

/document

The /document REST resource provides a wide range of operations that cover the same functionality, such as, creating, updating, or deleting documents.

The notable difference is that there is no direct equivalent for CreateOrUpdate. Instead, a conscious decision must be made to either create a document via POST /document or update an existing one via PUT /document. Additionally, the Hide and Unhide operations are achieved by simply updating a document and setting the hidden state.


Helpful Unhelpful

Add a comment

Please log in or register to submit a comment.

Need a password reminder?

Share