Core API URI Schema
The Core API provides access to OMN resources (data entities) and related operations via REST over HTTP. Each resource is exposed by a uniform resource identifier (URI).
Main Schema
The OMN Core URI has the following main schema:
https://\{host}/api/core/{api version}/\{module}/\{resources}/\{operation}
host: the OMN host name
/api/core/: represents the base path for all OMN Core API endpoints
api version: the Core API version (not the OMN version!)
module: the OMN module name (e.g. dam, pim, …) or common for cross-module endpoints.
resource: the name of the resource (data entity) in plural notation (e.g. assets)
operation: the operation to be executed on the resource (e.g. perform, persist, retrieve, query)
For example:
https://localhost/api/core/v1/dam/assets/persist
This endpoint will persist (create or update) the asset in DAM.
Binary Endpoint Schema
Endpoints for managing binary files have a different schema:
https://\{host}/api/core/{api version}/\{module}/\{resources}/bin/(chunked)\{operation}
/bin/: indicates that the endpoint is related to a binary file
chunked (optional): indicates that chunked file upload mechanism is used.
| The HTTP specification (RFC 9110) limits the maximum URL size to 255 bytes due to compatibility reasons. That is a reason why we avoid to use complex URIs and URI parameters. |