13.9. EKM REST API

Engineering Knowledge Manager

Administration Guide | Chapter 13: EKM Client API |

13.8. API Documentation |  | Chapter 14: Units: Defining and Configuring Using XML
Prev |  | Next

## 13.9. EKM REST API

The EKM server also provides a REST API that web applications and other clients can use to communicate with the server. The documentation for the REST API can be found in ekm-client/doc/rest/index.html.

The REST API provides a number of services that provide various operations for interacting with the EKM server. The services defined include the following:

Table 13.1: REST API Services

Service | Description
--- | ---
AdministrationManager | Provides operations for performing administrative tasks. These include tasks that require administrative privileges, such as managing users. These also include tasks that non-admin users can perform, such as querying the server for its current date and time.
DataManager | Provides operations for managing data in the EKM repository. These include standard CRUD operations as well as version control operations.
EkmFileTransferServiceManager | Provides operations for transferring files to and from an EKM server. File downloads transfer data directly from the EKM repository to the client. Uploads require two steps: The first is to upload the files via this interface. The second is to tell the EKM server to import the files via the DataManager interface.
SecurityManager | Provides operations to sign in to and out of an EKM server, as well as additional operations to manage the user's session once signed into the server.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.