OM restful web-api (Version: 15.2.23.0)

How it works

Append [action] and if necessary [object-id] (supported for GET, PUT, PATCH, DELETE) to querystring.

sample: /sample/324

Get json models

Add json to request-body if necessary (supported for POST, PUT, PATCH). To get the required json model call /[action]/json.

sample: /sample/json

Get query parameters

For some action there are query parameters available (currently supported for GET if no ID submitted). To get the required or optional parameters call /[action]/params.

sample: /sample/params

How it's authenticated

This webservice is protected with 'Basicure' authentication. The 'Authorization'-header is composed of the following.

user:   username (here 'user')
ts:     unixtimestamp utc
hash:   HMAC(Algorithm: SHA256) binary hash as base64 string (Encoding: ASCII)
           key is users password (here 'password')
           message is [action lowercase]/[HTTP-METHOD UPPERCASE]/[timestamp] (sample: sample/GET/1745906541)

Documentation

1. Read the documentation to understand the basic principles of OM restful web-api /file/documentation
2. Read the action-documentation the learn about available actions or endpoints respectively /file/action-documentation. Get the OpenAPI Specification (formerly Swagger Specification) /swagger/docs/V1.
3. For transactional procedures business processes are used. Read the business process documentation /file/business-process-documentation