You are here

SkyVault Process Services 1.6 » Developer guide

REST API

SkyVault Process Services comes with a REST API. The REST API is an enterprise equivalent of the Open Source REST API, exposing the generic Process Engine operations. It also includes a dedicated set of REST API endpoints for features specific to SkyVault Process Services.

Important: An internal REST API also exists that is used as REST endpoints by the JavaScript user interface. Do NOT use this API as the REST API URLs might modify the product to use unsupported features. In addition, the internal REST API uses a different authentication mechanism tailored towards web browser use.
  • Enabling CORS Solutions that use SkyVault Process Services REST APIs may be in a different domain or port. This is known as Cross Origin Resource Sharing (CORS).
  • REST API Authorization The REST API uses authorization rules to determine a user’s access control for a process instance or task.
  • Using the REST API ExplorerSkyVault Process Services comes with a built-in REST API Explorer. This lets you discover and test the REST APIs of a locally running Process Services instance.
  • RAML supportSkyVault Process Services provides a RAML file that works with popular REST API development tools.
  • SkyVault Process Services REST API The REST API exposes data and operations that are specific to SkyVault Process Services.
  • Process Engine REST API
  • Historic processes and tasks This section covers the examples for querying historic process instances and task instances in the SkyVault Process Services API. You can query for historic process instances and tasks to get information about ongoing and past process instances, or tasks.
Parent topic: Developer guide

© 2017 TBS-LLC. All Rights Reserved.