You are here

You are here

Migrating from the SOAP API to the REST API

If you are already using the SpringCM SOAP API, this page will help you map your existing code if you choose to transition to the SpringCM REST API.  The following table shows the equivalent REST API calls for a given SOAP call.  The REST API also includes additional functionality that is not exposed in the SOAP API.

SOAP API calls not listed here are either deprecated or scheduled to be upgraded in a future release.

 

SOAP API to REST API Mappings
SOAP API REST API

AccountGetCurrent

GET /{apiversion}/accounts/current

See also: Get the account of the current user

Authenticate

See the REST API Authentication section

AuthenticateNonDefault

See the REST API Authentication section

AuthenticateSSO

See Salesforce Client Flow Authentication section

BPMAbortWorkflow

DELETE /{apiversion}/workflows/{instanceId}

See also: Stop a workflow instance

BPMInitiateWorkflow

POST /{apiversion}/workflows

See also: Start a workflow instance
Pass the data to start the workflow in the Params property

BPMInitiateWorkflowWithDocuments

POST /{apiversion}/workflows

See also: Start a workflow instance
Pass the data to start the workflow in the WorkflowDocuments collection property

BPMSignalWorkflow

POST /{apiversion}/workflows/{instanceId}/signal

See also: Signal a workflow

BPMWorkflowInstanceInformation

GET /{apiversion}/workflows/{instanceId}

See also: Get a workflow instance

ContactFind

GET /{apiversion}/contacts

Filterable on Email, First Name, Last Name, Company
See also: Get the contacts of the current account

Copy

POST /{apiversion}/copytasks

See also: CopyTasks

Delete
DeleteBaseObjects

Use the DELETE method on the specific object HREF.  Will vary for object type:
Contacts – DELETE /{apiversion}/contacts/{id}
Documents – DELETE /{apiversion}/documents/{id}
Folders – DELETE /{apiversion}/folders/{id}
Groups – DELETE /{apiversion}/groups/{id}
Users – DELETE /{apiversion}/users/{id}

DocumentCheckin
DocumentCheckout
DocumentCheckoutCancel

Working with checkin’s and checkout’s without versioning the content is done with the “lock” object.  Document objects will always have one and only one “lock” object that manages the document checkin/checkout.

See the Content API documentation for details on working with the lock object as well as the Document object method level documentation

DocumentCreateBeginWithFolder
DocumentCreateCancel
DocumentCreateCheckin
DocumentCreateCommit
DocumentCreateFilesBegin
DocumentCreateFilesCommit
DocumentCreateUploadChunk

See the Content API documentation for information on uploading new documents.

DocumentDownload
DocumentDownloadPreviewImage
DocumentGetExtractedText
DocumentHash

See the Content API documentation for information on downloading documents in various supported formats.

DocumentGetById

GET /{apiversion}/documents/{id}

See also: Get a document by ID

DocumentGetPath

GET /{apiversion}/documents?path={path to document}

See also: Get a document by path

DocumentHistoryGetById

GET /{apiversion}/documents/{id}?expand=historyitems
GET /{apiversion}/documents/{id}/historyitems

See also: Get the history of a document

DocumentMerge
DocumentMergeCheck
DocumentMergeDownload

POST /{apiversion}/documentmergetasks

See also: DocumentMergeTasks

DocumentPagedSearch
DocumentSearch

POST /{apiversion}/documentsearchtasks

See also: DocumentSearchTasks

DocumentPublish

POST /{apiversion}/sharelinks

DocumentPublish is deprecated.  The Sharelinks object should be used instead.

DocumentSave

PUT  /{apiversion}/documents/{id}
PATCH /{apiversion}/documents/{id}

See also: PUT - Update a document, PATCH - Update a document

DocumentSendForSignature
DocumentSendForSignatureCancel
DocumentSendForSignatureStatus

POST /{apiversion}/signaturetasks

See also: SignatureTasks

DocumentSplit

POST /{apiversion}/splitdocumenttasks

See also: SplitDocumentTasks

DocumentXMLMerge
DocumentXMLMergeStatus

POST /{apiversion}/documentxmlmergetasks

See also: DocumentXmlMergeTasks

FindOrCreateEOSFolder

POST /{apiversion}/folders 

Must supply the EOSInfo object as child on the posted Folder object

The REST API also supports a method to find an EOS Folder that will not create the folder if it is not found:

GET /{apiversion}/folders?eosObjectType={EOS object type}&eosObjectId={EOS Object Id}

See also: Create a folder, Get a folder by EOS object id and type

FolderArchive
FolderArchiveDownload
FolderArchiveGetStatus

POST /{apiversion}/folderarchivetasks

See also: FolderArchiveTasks

FolderCreate

POST /{apiversion}/folders

See also: Create a folder

FolderGetById

GET /{apiversion}/folders/{id}

See also: Get a folder by ID

FolderGetContents
SystemFolderGetContents

GET /{apiversion}/folders/{id}?expand=documents,folders
GET /{apiversion}/folders/{id}/documents
GET /{apiversion}/folders/{id}/folders

See also: Get the documents in a folder, Get the folders in a folder

FolderGetPath

GET /{apiversion}/folders/{id}?expand=path

See also: Get a folder by path or system folder

FolderPagedSearch
FolderSearch

/POST /{apiversion/foldersearchtasks

See also: FolderSearchTasks

FolderSave

PUT  /{apiversion}/folders/{id}
PATCH  /{apiversion}/folders/{id}

See also: PUT - Update a folder, PATCH - Update a folder

GetDocumentRevisions

GET /{apiversion}/documents/{id}?expand=versions
GET /{apiversion}/documents/{id}/versions

See also: Get the versions of a document

GetMetadataFields

GET /{apiversion}/attributegroups/{id}

See also: Get an attribute group

GetMetadataGroups

GET /{apiversion}/accounts/current/attributegroups

See also: Get the attribute groups of the current account

GetRecentlyAccessedDocuments

GET /{apiversion}/users/current/recentdocuments

See also: Get the recently accessed documents for the current user

GroupFind

GET /{apiversion}/groups

Filterable on Name, GroupType
See also: Get the groups in the current account

GroupGetByContact

GET /{apiversion}/users/current?expand=groups
GET /{apiversion}/users/current/groups

See also: Get the groups of the current user

ImportSalesforceAttachments
ImportSalesforceAttachmentsStatus

POST /{apiversion}/salesforceattachmentimportasks

See also: SalesforceAttachmentImportTasks

Load

There is no generic load in the REST API.  Use GET requests to an object endpoint to load an object.

Move

There is no specific move task in the REST API.  To move a document or folder in the REST API, change the parent folder on the object and PUT/PATCH the document or folder.

ParsePath

No exact match in the REST API, but the same functionality can be obtained by first trying the document endpoint as a path, if it’s not found, try the path at the folder endpoint.

Save

There is no bulk save in the REST API.  PUT/PATCH to a specific object endpoint to save an object.

SetPermission

POST /{apiversion}/changesecuritytasks

See also: ChangeSecurityTasks

UserGetByAccountId

GET /{apiversion}/users

See also: Get the users in the current account