Skip to main content
Version: Next

REST APIs and Handlers Documentation

Process Suite v23 exposes several REST endpoints and HTTP handlers that allow interaction with the solution via JSON format.

HTTP Handlers (ASHX)​

Many APS features are accessible through .ashx files located in the Web/Model directory. These handlers are lightweight and optimized for asynchronous calls from browsers or third-party applications.

Main entry points​

  • WS/JsonDataAccess.ashx : Allows navigation through directories and files managed by APS.
  • Workflow/WorkflowHandler.ashx : Interface for workflow actions (validation, status consultation).
  • Forms/api/recommendation/Handler.ashx : API dedicated to recommendation and auto-completion engines.

Using APIs​

Calls are typically made via GET or POST requests with standard parameters.

Example of data retrieval (JSON)​

GET /Web/Model/WS/JsonDataAccess.ashx?node=RootNode HTTP/1.1
Host: your-aps-server

Typical response:

[
  {"text":"Public","id":"C:\\Apps\\Data\\Public","cls":"folder","iconCls":"folder","singleClickExpand":true},
  {"text":"User","id":"C:\\Apps\\Data\\User","cls":"folder","iconCls":"h_folder_user","singleClickExpand":true}
]

SOAP Web Service (ProcessStudioWebService)​

In addition to REST mode, APS offers a comprehensive SOAP Web Service for robust server-to-server integrations.

  • URL : /WebService/ProcessStudio/ProcessStudioWebService.asmx
  • WSDL : Accessible via /WebService/ProcessStudio/ProcessStudioWebService.asmx?wsdl

Available features​

  • Creating and modifying documents (SaveDocument)
  • Downloading and uploading attachments (SaveFileToDocument, DocumentGetAttachmentById)
  • Workflow management (StartWorkflowOnDocument, ValidateWorkflowOnDocument)
  • Web query execution (QueryDataSource)

API Security​

APIs inherit the application's authentication mode (ASP.NET Session, Windows Authentication or SSO). For server-to-server calls without interactive sessions, the use of service accounts or tokens is recommended.