Skip to main content

API

REST API development has been settled down in V21.12.

Here are the critical points for v4.x and v5.x API users.

  • v4.x Old XML/SOAP API is no longer supported in v5.6 and v21.12 and above.
  • Some XML/SOAP methods are still usable using the following URL.
    /OpenLM.Server.Services/AdminAPI/web/{adminApiMethod}
  • Some of the v5.x REST APIs were changed in V21.12 and higher.
  • Swagger API Lists are all the APIs for customer use and documents.
    HTTP(s)://fqdn:5015/swagger/index.html

How to use Postman

VideoCSV for Import

Note: If you are not using Identity Service Security Mode, you can access it without Bearer Token.
You don't need to get Token from Identity Service.

Sample code

C#

Note: If you are not using Identity Service Security Mode, you can access it without Bearer Token
You don't need to get a Token from Identity Service.

How to use Swagger

  1. Get Token from Postman.
  2. Open Swagger UI and click on Authorize. Screenshot: How to use Swagger
  3. Paste the Token in the text box according to the instructions.
    Screenshot 2: How to use Swagger
  4. Choose the desired API method. Screenshot 3: How to use Swagger
  5. Fill in all the necessary parameters. The current API version is 1: Screenshot 4: How to use Swagger
  6. Run the request and get results.
    Screenshot 5: How to use Swagger

Note: If you are not using Identity Service Security Mode, you can access it without Bearer Token
There is no need to get a Token from Postman.