Reference by Ref

Developing

GET

https:/omerlo.com/api/media/v1/references/{ref}

The expected ref must have the following format : <provider>:<id> (e.g. omerlo:123).

omerlo is the provider (where the id comes from).
id is the id from the provider system.

This return a full reference defined by provider, id and urn. The urn correspond to a unique id from Omerlo CMS.

Here some URN examples:

for a content: docs:contents:fd3a2352-4810-4d9e-af29-11f1d5d7b0b9

for a person: community:person:158ea986-2b54-4baa-b9ab-645d0f964888

for a project: community:project:e3d15fde-685b-4246-be2c-a6edb2303d20

etc

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

🟢200Success

application/json

Body

🟠400Missing x-omerlo header

🟠401Authorization

🟠404Entity not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https/omerlo.com/api/media/v1/references/provider:id' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "provider": "string",
        "urn": "string"
    },
    "assocs": {}
}