DAM API
DAM API provides access to resources of the DAM module and is used to manage and structure digital assets.
Main resources:
| Resource | Description |
|---|---|
Asset |
Any digital asset that is supported by OMN. An asset can be, for example, an image, a photo, a graphic, a video, an audio file, a 3D file, a 360° product image or a document. |
Version |
Versions are different states of a file, e.g. a modified version of an image. Each version of a file has the same file name. In contrast to Variations , there can only be one active version of a file in OMN at one time, which is displayed in all standard views, e.g. in the table, and is used in OMN. |
Variation |
Variations (aka variants) are separate files that are related to each other and usually have different file names. |
Directory |
Represents a directory (aka folder) in a directory tree structure which can contain sub-directories or Assets. |
RNC |
Abbreviation for Root Node Configuration which represents a configuration of FileSystem accesses for OMN, which is configured in the OMN configuration client. |
Assets API
Provides operations on OMN assets and related asset information.
Chunked upload. Start
| /dam/assets/bin/chunked/start Initializes a chunk upload session for the file |
Chunk upload workflow consist of 3 general steps:
Resource path |
/api/core/v1/dam/assets/bin/chunked/start |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Return Type
OmnType with filled ResponsesType
Response type contains upload tid - the unique identity of the upload session. Upload tid is required for next upload steps.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with filled ResponsesType |
|
400 |
Invalid input provided |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Start upload session
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/bin/chunked/start' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"path":"/MAM/demo/file2.jpg",
"tid": "AAAAA-AAAAA-AAAAAA-AAAAAA",
}'Request body AssetUploadRequest
{
"tid":"0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
"path": "/MAM/demo/filename.jpg"
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response tid="9f9417cc-031b-4bf4-ae98-e1df1fc93fef">
<status>SUCCESS</status>
<description>Chunk upload could be started by upload UUID/tid</description>
</response>
</responses>
</pim>Error responses
File already exists
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">f21311c9-a868-4d4e-bc48-adaa96436335</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">File already exists by path: '/demo/file.jpg'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>File already exists with the provided tid, but in another path
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">f21311c9-a868-4d4e-bc48-adaa96436335</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">File already exists by path: '/demo/file.jpg'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No access to the destination
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">9fdfc6ce-6999-4f3b-8513-be5c431974ee</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">No permissions to upload by path: /demo/file.jpg</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No destination
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">9fdfc6ce-6999-4f3b-8513-be5c431974ee</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">No target directory by path: '[demo]' in rnc: 'MAM'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>Chunked upload. Upload a chunk
| /dam/assets/bin/chunked/upload/{uploadTid} Upload a specified chunk of an asset. |
| Upload session must be started before a chunk upload. |
Resource path |
|
HTTP method |
POST |
Request content type |
multipart/form-data |
Response content type |
|
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
uploadTid |
The session identifier of the started chunked upload. |
X |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
chunkId |
Identity of an asset chunk which should be uploaded integer |
X |
Int32. Positive numbers starting from 0. |
|
payload |
Blob file |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Upload a chunk
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/bin/chunked/upload/9f9417cc-031b-4bf4-ae98-e1df1fc93fef' \
--header 'Authorization: Bearer <TOKEN>' \
--form 'payload=@"<PATH_TO_FILE>500x500.jpg"' \
--form 'chunkId="0";type=application/json'Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="create" id="0" tid="c15af96a-4ce2-4d05-8965-e375c00daf1b">
<status>SUCCESS</status>
<description>Chunk has been uploaded</description>
</response>
</responses>
</pim>Chunked upload. Finish
| /dam/assets/bin/chunked/persist/{uploadTid} Finalize the chunking upload of an asset. |
| Some chunks should be uploaded before notifying the server that API consumer uploaded all chunks. |
Resource path |
|
HTTP method |
PUT |
Request content type |
application/json |
Response content type |
|
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
uploadTid |
The session identifier of the started chunked upload. |
X |
Body parameters
Specified by AssetUploadRequest.
The AssetUploadRequest's path and tid parameters should be the same as was sent for /dam/assets/bin/chunked/start
| path is required and should contain the file name. |
Return Type
PimType with filled ResponsesType
Response type contains status and info about asset that were uploaded to the system.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input provided |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Finalize upload session
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/bin/chunked/persist/c9fd0ff5-69e6-4053-b895-887be66ccfd9' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"path":"/MAM/demo/file2.jpg",
"tid": "AAAAA-AAAAA-AAAAAA-AAAAAA",
"doPreviewsAsync": true,
"doOverwrite": true
}'Request body AssetUploadRequest
{
"tid":"0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
"path": "/MAM/demo/filename.jpg",
"doPreviewsAsync": true,
"doOverwrite": true
}Response body. With status and uploaded asset info
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="create"
dataType="asset"
id="75440"
path="/demo/file.jpg"
tid="1296BDF9-E367-492C-ACB8-59FA7C310CE8">
<status>SUCCESS</status>
<description>The asset has been uploaded</description>
</response>
</responses>
</pim>Error responses
It is possible, that during chunks upload, the another file with the same name and path or tid was uploaded to the system, target or the target directory is not available.
File already exists:
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">f21311c9-a868-4d4e-bc48-adaa96436335</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">File already exists by path: '/demo/file.jpg'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>File already exists with the provided tid, but in another path
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">f21311c9-a868-4d4e-bc48-adaa96436335</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">File already exists by path: '/demo/file.jpg'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No access to the destination
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">9fdfc6ce-6999-4f3b-8513-be5c431974ee</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">No permissions to upload by path: /demo/file.jpg</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No destination
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">9fdfc6ce-6999-4f3b-8513-be5c431974ee</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">No target directory by path: '[demo]' in rnc: 'MAM'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>Retrieve Binary Assets
| /dam/assets/bin/retrieve Retrieves binary data of asset(s). |
Resource path |
/api/core/v1/dam/assets/bin/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
application/octet-stream |
Body parameters
Specified by AssetRequest
-
tids - (List of String) - Filter parameter, asset TIDs (Metatag GUID), identifying unique objects
-
ids - (List of Integer) - Filter parameter, asset IDs, identifying unique objects
-
formats - (List of String) - Filter parameter, asset formats, identifying preview format or asset.
Return Type
Binary data. In case when multiple assets and / or multiple formats are requested, then files will be compressed into the zip. The zip file should be of the following structure: One directory per tid/id. In this directory the file name of the asset + the format prefix (+ file-suffix) should be used as file name.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with list of keywords |
|
400 |
Invalid input provided |
|
404 |
The requested resource could not be found |
|
500 |
An unknown internal error occurred |
Samples
curl sample
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/bin/retrieve' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <TOKEN> ' \
--data-raw <REQUEST_BODY>Initial data: 2 files
1st file:
-
name: apollon_logo.jpg
-
identity: 1331131
-
tid: 05954601-9289-49A7-8652-BE74A7DB0E06
2nd file:
-
name: apollon_bg.png
-
identity: 22738178
-
tid: 7CD062AE-B69E-47D5-8422-8840E4A22E88
1. Retrieve asset by id
Request body
{
"ids": [1331131]
}Response body. The file
apollon_logo_original.png2. Retrieve single asset by tid
Request body
{
"tids": ["7CD062AE-B69E-47D5-8422-8840E4A22E88"]
}Response body. The file
apollon_bg_original.png3. Retrieve multiple assets by tids/ids:
Request body. By id
{
"ids": [1331131, 22738178]
}or
Request body. By tid
{
"tids": ["7CD062AE-B69E-47D5-8422-8840E4A22E88", "05954601-9289-49A7-8652-BE74A7DB0E06"]
}Response body. Zip with several assets files
result.zip
|----- 7CD062AE-B69E-47D5-8422-8840E4A22E88
| |---- apollon_logo_original.jpg
|
|----- 05954601-9289-49A7-8652-BE74A7DB0E06
|---- apollon_bg_original.png4. Retrieve single asset’s single preview
Request body
{
"ids": [1331131],
"formats": ["previewThumbnail"]
}Response body. The file preview
apollon_logo_previewThumbnail.png5. Retrieve single asset’s multiple previews:
Request body
{
"ids": [1331131],
"formats": ["previewThumbnail", "previewOriginal"]
}Response body. Zip with several previews
result.zip
|----- 7CD062AE-B69E-47D5-8422-8840E4A22E88
|---- apollon_logo_previewThumbnail.jpg
|---- apollon_logo_previewOriginal.jpg6. Retrieve multiple asset’s multiple previews:
Request body
{
"tids": ["7CD062AE-B69E-47D5-8422-8840E4A22E88", "05954601-9289-49A7-8652-BE74A7DB0E06"],
"formats": ["previewThumbnail", "previewOriginal"]
}Response body. Zip with several previews
result.zip
|----- 7CD062AE-B69E-47D5-8422-8840E4A22E88
| |---- apollon_logo_previewThumbnail.jpg
| |---- apollon_logo_previewOriginal.jpg
|
|----- 05954601-9289-49A7-8652-BE74A7DB0E06
|---- apollon_bg_previewThumbnail.jpg
|---- apollon_bg_previewOriginal.jpgAsset upload
| /dam/assets/bin/persist Upload asset to the system. |
Semantic is the same as in chunked asset upload. Within this endpoint it’s possible to upload file per one request without splitting to chunks.
Resource path |
|
HTTP method |
POST |
Request content type |
multipart/form-data |
Response content type |
|
Form Parameters
| AssetUploadRequest.path should be provided to the OMN known directory. |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
params |
Upload parameters AssetUploadRequest |
X |
||
payload |
Blob file |
X |
Return Type
PimType with filled ResponsesType
Response type contains status and info about upload asset operation.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input |
|
409 |
File already exists |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Upload a file
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/bin/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--form 'payload=@"/<FILE_PATH>/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500.jpg"' \
--form 'params="{
\"path\":\"/MAM/demo/\",
\"tid\": \"AAAAA-AAAAA-AAAAAA-AAAAAA\",
\"doPreviewsAsync\": true,
\"doOverwrite\": true
}";type=application/json''Request body AssetUploadRequest
{
"path":"/MAM/demo/",
"tid": "AAAAA-AAAAA-AAAAAA-AAAAAA",
"doPreviewsAsync": true,
"doOverwrite": true
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="create"
dataType="asset"
id="86670"
path="/MAM/demo/file.jpg"
tid="AAAAA-AAAAA-AAAAAA-AAAAAA">
<status>SUCCESS</status>
<description>The asset has been uploaded</description>
</response>
</responses>
</pim>Error response
No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">9fdfc6ce-6999-4f3b-8513-be5c431974ee</itm>
</details>
<issues>
<itm key="code">1000</itm>
<itm key="description">An unknown internal error occurred</itm>
<itms type="details">
<itm key="errorMessage">No permissions to upload by path: /demo/file.jpg</itm>
</itms>
</issues>
<status>ERROR</status>
</response>Assets already exists
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">d2540d63-e9b5-4647-b875-bcb0c9dfabe5</itm>
</details>
<issues>
<itm key="code">1003</itm>
<itm key="description">The resource already exists</itm>
<itms type="details">
<itm key="errorMessage">File already exists by path: '/demo/file.jpg'</itm>
</itms>
</issues>
<status>ERROR</status>
</response>Retrieve assets previews info
| /dam/assets/previews/retrieve Retrieve assets previews information. |
Resource path |
/api/core/v1/dam/assets/previews/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by PreviewInfoRequest
Return Type
OmnType with filled AssetsType. More info AssetType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with assets preview info in AssetType |
|
500 |
Error in ResponseType |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Get previews info
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/previews/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"tids":[
"11319367-DE26-4FB8-9148-3C341766C1BA"
],
"formats": [
"original",
"previewOriginal",
"previewCoarse",
"previewThumbnail",
"previewCustom",
"previewOriginalPixel",
"previewOriginalVector",
"previewOriginalMultimedia"
]
}'Request body:
by ids:
{
"ids": [
74628354
],
"formats": [
"original",
"previewOriginal",
"previewCoarse",
"previewThumbnail",
"previewCustom",
"previewOriginalPixel",
"previewOriginalVector",
"previewOriginalMultimedia"
]
}by tids:
{
"tids": [
"11319367-DE26-4FB8-9148-3C341766C1BA"
],
"formats": [
"original",
"previewOriginal",
"previewCoarse",
"previewThumbnail",
"previewCustom",
"previewOriginalPixel",
"previewOriginalVector",
"previewOriginalMultimedia"
]
}by paths:
{
"paths": [
"/MAM/rootDirectory/childDirectory1/pic.jpeg"
],
"formats": [
"original",
"previewOriginal",
"previewCoarse",
"previewThumbnail",
"previewCustom",
"previewOriginalPixel",
"previewOriginalVector",
"previewOriginalMultimedia"
]
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-09-19T09:46:46.471Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<assets>
<asset tid="11319367-DE26-4FB8-9148-3C341766C1BA">
<name>artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500_print_variation_print_variation.jpg</name>
<meta>
<itm key="identity">87961</itm>
<itm key="pathStringStr">/demo/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500_print_variation_print_variation.jpg</itm>
</meta>
<previews>
<preview tid="E5B04787-87BD-4D18-AAA6-6CD26498EB0A" type="ORIGINAL_PIXEL">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">230</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewOriginalPixel</itm>
<itm key="width">219</itm>
</meta>
</preview>
<preview tid="0B0A042E-6F51-44C2-8CE7-5F13E4719FCF" type="THUMBNAIL">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">40</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewThumbnail</itm>
<itm key="width">38</itm>
</meta>
</preview>
<preview tid="11F00126-6D35-4355-99C3-2763A9743C00" type="COARSE">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">480</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewCoarse</itm>
<itm key="width">457</itm>
</meta>
</preview>
</previews>
</asset>
</assets>
</pim>Perform actions on assets
| /dam/assets/perform Perform different types of actions on DAM assets |
Available action types:
-
Delete
-
Move
-
Copy
-
Checkin (unlock)
-
Checkout (lock)
-
Clean checkout (force unlock)
Resource path |
/api/core/v1/dam/assets/perform |
HTTP method |
POST |
Request content type |
|
Response content type |
|
Body parameters
PimType with ActionTypes
API consumer should provide one of asset identifiers (usually tid) to perform action/s on the asset.
Some actions require additional info that should be provided in MetaType in key/value way.
ActionType's type is required and be provided.
Possible values:
-
delete
-
checkout
-
checkin
-
cleanCheckout
-
unlink
-
move
-
copy
ActionType's dataType is - asset
|
Tables legend
"As <action> attribute" describes, that parameter is in the xml attribute of <action> tag. Otherwise, parameter should be in ItemType. "Required groups" - one of parameter in the one group is required e.g. entity identifier (e.g. tid or id or path) |
| Parameter Name | As <action> attribute | Required | Type | Description | Format |
|---|---|---|---|---|---|
tid |
X |
X |
string |
Tid of the asset that should be deleted |
| Parameter Name | As <action> attribute | Required | Type | Description | Format |
|---|---|---|---|---|---|
tid |
X |
X G1 |
string |
Tid of the asset that should be moved |
|
id |
X |
X G1 |
Long |
Asset identity |
int64 |
path |
X |
X G1 |
string |
Path to the asset. Starts from RNC name. |
/ (forward slash) - as separator. RNC identifier - as root entry. |
destinationDirTid |
X G2 |
string |
Destination directory Tid |
||
destinationDirId |
X G2 |
Long |
Destination directory Id |
int64 |
|
destinationDirPath |
X G2 |
string |
Path to the destination directory. Starts from RNC name. |
/ (forward slash) - as separator. RNC identifier - as root entry. |
|
overwrite |
boolean |
Overwrite file if exists |
true/false |
| Parameter Name | As <action> attribute | Required | Type | Description | Format |
|---|---|---|---|---|---|
tid |
X |
X |
string |
Tid of the asset that should checked-in/checked-out or cleaned from checkout |
Return Type
PimType with filled ResponsesType
Response types contains status information about each action passed to perform.
Responses
| Actions are processed separately. ResponseType for individual action need to checked. Exceptions thrown during the execution of actions will be reported in ResponseType. |
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType. |
|
400 |
Invalid input provided |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Delete
Delete asset by tid
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE" type="delete"/>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE" type="delete"/>
</actions>
</pim>Response example
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T13:24:53.286Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE"
action="delete">
<status>SUCCESS</status>
<description>The asset has been deleted successfully</description>
</response>
</responses>
</pim>Error response case
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T13:36:54.983Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE2"
action="delete">
<status>ERROR</status>
<description>There is no asset with the given tid</description>
</response>
</responses>
</pim>Move
Move asset by tid/id/path
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml; charset=UTF8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1" type="move">
<meta>
<itm key="destinationDirTid">52F78637-63AE-4F3E-8D4B-664E070C6AB8</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Move request body examples:
By Tid
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1" type="move">
<meta>
<itm key="destinationDirTid">52F78637-63AE-4F3E-8D4B-664E070C6AB8</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>By id
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" id="74638" type="move">
<meta>
<itm key="destinationDirId">55273453</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>By path
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" path="/MAM/demo/photo.jpg" type="move">
<meta>
<itm key="destinationDirPath">/MAM/demo/copies/</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:53:35.841Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1"
id="74638"
action="move"
path="/MAM/demo/copies/photo.jpg">
<status>SUCCESS</status>
<description>asset has been moved</description>
<details>
<itm key="monitorId">77833</itm>
</details>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:05.989Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" action="move" path="/MAM/demo/copies/photo2.jpg">
<status>ERROR</status>
<description>The asset does not exist</description>
</response>
</responses>
</pim>The destination doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:31.036Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" action="move" path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>The destination does not exist</description>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T11:06:29.771Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="9EC194D7-07B6-48A1-BDD3-19C729492F7E"
id="76890"
action="move"
path="/MAM/demo/copies/tempAR/photo.jpg">
<status>ERROR</status>
<description>Error during moving: No access to source objects</description>
</response>
</responses>
</pim>No access to the destination
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:57.295Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="0F837828-AE84-431A-BC79-65B967C6400D"
id="73442"
action="move"
path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>Error during moving: No access to destination object '/demo/copies/tempAR'</description>
</response>
</responses>
</pim>Collision
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T11:07:26.533Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="E40ACAEB-963C-4D06-B3ED-7C01B3E51C37"
id="77971"
action="move"
path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>Collision during move. Collision asset name:'photo.jpg'</description>
<details>
<itm key="collision">true</itm>
<itm key="monitorId">77835</itm>
</details>
</response>
</responses>
</pim>Copy
Copy asset by tid/id/path
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml; charset=UTF8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1" type="copy">
<meta>
<itm key="destinationDirTid">52F78637-63AE-4F3E-8D4B-664E070C6AB8</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Copy request body examples:
By Tid
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1" type="copy">
<meta>
<itm key="destinationDirTid">52F78637-63AE-4F3E-8D4B-664E070C6AB8</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>By id
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" id="74638" type="copy">
<meta>
<itm key="destinationDirId">55273453</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim><?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" path="/MAM/demo/photo.jpg" type="copy">
<meta>
<itm key="destinationDirPath">/MAM/demo/copies/</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:53:35.841Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="52F78637-63AE-4F3E-8D4B-664E070C6AA1"
id="74638"
action="copy"
path="/MAM/demo/copies/photo.jpg">
<status>SUCCESS</status>
<description>asset has been copied</description>
<details>
<itm key="monitorId">77833</itm>
</details>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:05.989Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" action="copy" path="/MAM/demo/copies/photo2.jpg">
<status>ERROR</status>
<description>The asset does not exist</description>
</response>
</responses>
</pim>The destination doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:31.036Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" action="copy" path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>The destination does not exist</description>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T11:06:29.771Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="9EC194D7-07B6-48A1-BDD3-19C729492F7E"
id="76890"
action="copy"
path="/MAM/demo/copies/tempAR/photo.jpg">
<status>ERROR</status>
<description>Error during moving: No access to source objects</description>
</response>
</responses>
</pim>No access to the destination
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T10:54:57.295Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="0F837828-AE84-431A-BC79-65B967C6400D"
id="73442"
action="copy"
path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>Error during moving: No access to destination object '/demo/copies/tempAR'</description>
</response>
</responses>
</pim>Collision
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-17T11:07:26.533Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="E40ACAEB-963C-4D06-B3ED-7C01B3E51C37"
id="77971"
action="copy"
path="/MAM/demo/photo.jpg">
<status>ERROR</status>
<description>Collision during copy. Collision asset name:'photo.jpg'</description>
<details>
<itm key="collision">true</itm>
<itm key="monitorId">77845</itm>
</details>
</response>
</responses>
</pim>Checkin
Checkin asset by tid
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml; charset=UTF8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="checkin"/>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="checkin"/>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-17T09:23:08.154Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="71A1021B-786C-4538-8883-70A1C6754034"
action="update">
<status>SUCCESS</status>
<description>The asset has been checked-in</description>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:38:06.734Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122" action="update">
<status>ERROR</status>
<description>Isy object with meta tag guid 'DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122' is not found.</description>
</response>
</responses>
</pim>The asset is locked by another user
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:40:00.264Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A512" action="update">
<status>ERROR</status>
<description>The asset is checked-out (locked) by another user</description>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:40:00.264Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A512" action="update">
<status>ERROR</status>
<description>The asset access is denied</description>
</response>
</responses>
</pim>Checkout
Checkout asset by tid
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml; charset=UTF8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="checkout"/>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="checkout"/>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-17T09:23:08.154Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="71A1021B-786C-4538-8883-70A1C6754034"
action="update">
<status>SUCCESS</status>
<description>The asset has been checked-out</description>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:38:06.734Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122" action="update">
<status>ERROR</status>
<description>Isy object with meta tag guid 'DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122' is not found.</description>
</response>
</responses>
</pim>The asset is locked by another user
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:40:00.264Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A512" action="update">
<status>ERROR</status>
<description>The asset is checked-out (locked) by another user</description>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:40:00.264Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A512" action="update">
<status>ERROR</status>
<description>The asset access is denied</description>
</response>
</responses>
</pim>Clean checkout
Clean checkout asset by tid
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml; charset=UTF8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="cleanCheckout"/>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="asset" tid="71A1021B-786C-4538-8883-70A1C6754034" type="cleanCheckout"/>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-17T09:23:08.154Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="71A1021B-786C-4538-8883-70A1C6754034"
action="update">
<status>SUCCESS</status>
<description>The asset has been clean from checkout</description>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:38:06.734Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122" action="update">
<status>ERROR</status>
<description>Isy object with meta tag guid 'DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A5122' is not found.</description>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-14T14:40:00.264Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="DB2B33D8-C9DF-4A0B-BCC4-F5222CB8A512" action="update">
<status>ERROR</status>
<description>The asset access is denied</description>
</response>
</responses>
</pim>Retrieve assets
| /dam/assets/retrieve Retrieve asset information and attributes details. |
The endpoint can also provide information about previews and asset’s history.
Resource path |
/api/core/v1/dam/assets/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Asset attributes
Asset attributes are stored in AssetType.vals
Asset attributes type and examples
| Attribute type | Is localized | Response template | Example |
|---|---|---|---|
Boolean |
|
|
|
Boolean |
X |
|
|
Date |
|
|
|
Date |
X |
|
|
Enumeration |
|
|
|
Enumeration |
X |
|
|
Number |
|
|
|
Number |
X |
|
|
String |
|
|
|
String |
X |
|
|
XMP |
|
|
Body parameters
Specified by AssetRequest
Return Type
PimType with filled AssetsType. More info AssetType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with list of assets |
|
500 |
Error in ResponseType |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Get asset details with asset history and previews info
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ids": [
24478
],
"retrieveHistory": true,
"retrievePreviews": true
}'Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<assets>
<asset parent="01427CB0-AF41-41CF-96FC-51EC7B6ADEC1"
tid="6FC0022A-E978-4ADF-ABFE-DBF0BE99042F"
type="IMG">
<name>100192855000_96p.jpg</name>
<meta>
<itm key="annotationstate">false</itm>
<itm key="archivestate">ONLINE</itm>
<itm key="creationDate">2022-10-04T11:39:13.943+02:00</itm>
<itm key="discriminator">IMG</itm>
<itm key="fileCreationDate">2022-10-04T11:39:13.937+02:00</itm>
<itm key="fileModificationDate">2022-10-04T11:39:13.937+02:00</itm>
<itm key="fileTypeShortName">JPEG</itm>
<itm key="hidden">false</itm>
<itm key="identity">24478</itm>
<itm key="imageColorspace">YCBCR</itm>
<itm key="imageHeightInMM">705.5555555555555</itm>
<itm key="imageHeightInPixel">2000</itm>
<itm key="imageICCProfile">sRGB IEC61966-2-1 withBPC</itm>
<itm key="imageWidthInMM">465.66666666666663</itm>
<itm key="imageWidthInPixel">1320</itm>
<itm key="imageXResolutionValue">72.0</itm>
<itm key="imageYResolutionValue">72.0</itm>
<itm key="modificationDate">2022-10-04T11:39:16.272+02:00</itm>
<itm key="nameWithoutExtension">100192855000_96p</itm>
<itm key="numberOfVersions">0</itm>
<itm key="online">true</itm>
<itm key="pathStringStr">/Productimages/100/192/855/100192855000_96p.jpg</itm>
<itm key="previewCoarse">1C85040C-D61C-41E7-97CC-15B08B0675FE</itm>
<itm key="previewOriginal"/>
<itm key="previewOriginalMultimedia"/>
<itm key="previewOriginalPixel">48C064B8-B3EC-4476-A84B-11474684FF2B</itm>
<itm key="previewOriginalVector"/>
<itm key="previewThumbnail">FC24D91C-69FE-4FB3-A6FA-B9A66EB37CBC</itm>
<itm key="resourceSize">0</itm>
<itm key="rncIdentifier">MAM</itm>
<itm key="size">112209</itm>
<itm key="totalChecksum">8a6c74821055ccc8da8603eed6976017</itm>
<itm key="totalChecksumHashAlgorithm">MD5</itm>
<itm key="totalSize">112209</itm>
</meta>
<vals>
<val attr="xmp.IPTC.Description" type="xmp">
<itm>100192296041383437</itm>
</val>
<val attr="xmp.dc:description" type="xmp">
<itm>100192296041383437</itm>
</val>
<val attr="xmp.dc:subject" type="xmp">
<itm>1001/100192/855000/19;</itm>
</val>
<val attr="xmp.tiff.Orientation" type="xmp">
<itm>1</itm>
</val>
<val attr="xmp.dc:creator" type="xmp">
<itm>p</itm>
</val>
<val attr="xmp.IPTC.Keywords" type="xmp">
<itm>1001/100192/855000/19;</itm>
</val>
<val attr="xmp.dc:format" type="xmp">
<itm>image/jpeg</itm>
</val>
<val attr="xmp.IPTC.Creator" type="xmp">
<itm>p</itm>
</val>
<val attr="xmp.exif:ExposureTime" type="xmp">
<itm>1/160</itm>
</val>
<val attr="STRING_SIMPLE">
<itm>string</itm>
</val>
<val attr="ENUMERATION_L" type="multi_loc">
<i18n loc="en_EN">
<itm pos="0">Brown</itm>
<itm pos="1">Yellow</itm>
</i18n>
</val>
</vals>
<histories>
<history id="37220">
<meta>
<itm key="changedProperty">STRING_SIMPLE</itm>
<itm key="eventDate">2022-10-21T15:45:04.110+02:00</itm>
<itm key="eventDescription">Saving object details.</itm>
<itm key="eventIdentifier">SAVE_DETAILS</itm>
<itm key="newValue">testttest</itm>
<itm key="oldValue">aeorosol</itm>
<itm key="userIdentifier">test@apollon.de</itm>
</meta>
</history>
<history id="54321">
<meta>
<itm key="changedProperty">STRING_SIMPLE</itm>
<itm key="eventDate">2022-10-21T15:45:15.928+02:00</itm>
<itm key="eventDescription">Saving object details.</itm>
<itm key="eventIdentifier">SAVE_DETAILS</itm>
<itm key="newValue">hi</itm>
<itm key="oldValue">testttest</itm>
<itm key="userIdentifier">test@apollon.de</itm>
</meta>
</history>
</histories>
<previews>
<preview tid="E5B04787-87BD-4D18-AAA6-6CD26498EB0A" type="ORIGINAL_PIXEL">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">230</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewOriginalPixel</itm>
<itm key="width">219</itm>
</meta>
</preview>
<preview tid="0B0A042E-6F51-44C2-8CE7-5F13E4719FCF" type="THUMBNAIL">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">40</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewThumbnail</itm>
<itm key="width">38</itm>
</meta>
</preview>
<preview tid="11F00126-6D35-4355-99C3-2763A9743C00" type="COARSE">
<meta>
<itm key="extension">jpeg</itm>
<itm key="height">480</itm>
<itm key="modificationDate">2022-09-08T13:11:29.802Z</itm>
<itm key="pageNumber">-1</itm>
<itm key="size">0</itm>
<itm key="status">ORIGINAL</itm>
<itm key="url">/dam/assets/bin?assetTid=11319367-DE26-4FB8-9148-3C341766C1BA&format=previewCoarse</itm>
<itm key="width">457</itm>
</meta>
</preview>
</previews>
</asset>
</assets>
</pim>Persist assets
| /dam/assets/persist Saves asset information and asset attributes details. |
Allows to
Resource path |
/api/core/v1/dam/assets/persist |
HTTP method |
POST |
Request content type |
|
Response content type |
|
Asset attribute persisting
Asset attributes are stored in AssetType.vals. More info about asset attributes
| Only provided attribute values are persisted, other values that are not provided in AssetType.vals will be not changed. |
| Only values of attributes registered in OMN could be saved. |
Keyword link persisting
Keyword links are stored in AssetType.links. See below for sample
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2024-05-08T09:42:06.853Z</itm>
<itm key="sourceEnv">ocd_dev</itm>
</meta>
<assets>
<asset id="58525" parent="7CFD9FB3-8124-4363-8C06-B844CC58249C" tid="5B8EF672-A396-43BC-B880-E8B1FC2F7376" type="IMG">
<name>MyAsset.jpg</name>
<links>
<itms mode="delta" type="kwds">
<itm pos="1">/MyRootKW/MySubKW</itm>
</itms>
</links>
</asset>
</assets>
</pim>| Only existing keywords can be linked. Non-existent keywords won’t be created automatically. |
Body parameters
Accepts PimType with AssetsType
Return Type
PimType with statuses ResponsesType about each persisted asset.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with list of responses |
|
500 |
Error in ResponseType |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Save asset attributes and new name
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '<BODY>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<assets>
<asset parent="01427CB0-AF41-41CF-96FC-51EC7B6ADEC1"
tid="6FC0022A-E978-4ADF-ABFE-DBF0BE99042F"
type="IMG">
<name>100192855000_96p.jpg</name>
<vals>
<val attr="STRING_SIMPLE">
<itm>string</itm>
</val>
<val attr="NUMBER_SIMPLE">
<itm>6395629</itm>
</val>
<val attr="ENUMERATION_L" type="multi_loc">
<i18n loc="en_EN">
<itm pos="0">Brown</itm>
<itm pos="1">Yellow</itm>
</i18n>
</val>
<val attr="xmp.IPTC.Description" type="xmp">
<itm>100192296041383437</itm>
</val>
<val attr="xmp.dc:description" type="xmp">
<itm>100192296041383437</itm>
</val>
<val attr="xmp.dc:subject" type="xmp">
<itm>1001/100192/855000/19;</itm>
</val>
<val attr="xmp.tiff.Orientation" type="xmp">
<itm>1</itm>
</val>
<val attr="xmp.IPTC.Keywords" type="xmp">
<itm>1001/100192/855000/19;</itm>
</val>
<val attr="xmp.dc:format" type="xmp">
<itm>image/jpeg</itm>
</val>
<val attr="xmp.IPTC.Creator" type="xmp">
<itm>p</itm>
</val>
<val attr="xmp.exif:ExposureTime" type="xmp">
<itm>1/160</itm>
</val>
</vals>
</asset>
</assets>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-03T07:28:00.168Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="ASSET" tid="71A1021B-786C-4538-8883-70A1C6754034" action="update">
<status>SUCCESS</status>
<description>The asset has been saved successfully</description>
</response>
</responses>
</pim>Link keywords to asset
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '<BODY>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2024-05-08T09:42:06.853Z</itm>
<itm key="sourceEnv">ocd_dev</itm>
</meta>
<assets>
<asset id="58525" parent="7CFD9FB3-8124-4363-8C06-B844CC58249C" tid="5B8EF672-A396-43BC-B880-E8B1FC2F7376" type="IMG">
<name>MyAsset.jpg</name>
<links>
<itms mode="delta" type="kwds">
<itm pos="0">/MyRootKeyword</itm>
<itm pos="1">/AnotherRootKeyword/MySubKeyword</itm>
</itms>
</links>
</asset>
</assets>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-03T07:28:00.168Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="ASSET" tid="71A1021B-786C-4538-8883-70A1C6754034" action="update">
<status>SUCCESS</status>
<description>The asset has been saved successfully</description>
</response>
</responses>
</pim>Error responses
The asset doesn’t exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-03T07:46:16.200Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="71A1021B-786C-4538-8883-70A1C675403422" action="update">
<status>ERROR</status>
<description>The asset does not exist</description>
</response>
</responses>
</pim>The keyword doesn’t exist
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pim xmlns="http://www.apollon.de/omn">
<meta>
<itm key="messageType">response</itm>
<itm key="messageTime">2024-05-13T04:54:05.030Z</itm>
<itm key="refMessageId">1131</itm>
<itm key="sourceEnv">ocd_dev</itm>
</meta>
<responses>
<response dataType="asset" tid="5B8EF672-A396-43BC-B880-E8B1FC2F7376">
<status>SUCCESS</status>
<issues type="1002">
<itm key="description">Keyword could not be linked: Keyword with path '/nonexistentkeyword' not found.</itm>
</issues>
</response>
</responses>
</pim>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-03T07:46:16.200Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset" tid="71A1021B-786C-4538-8883-70A1C675403422" action="update">
<status>ERROR</status>
<description>The asset does not exist</description>
</response>
</responses>
</pim>No access rights to save some attributes
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T09:15:35.301Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="ASSET" tid="71A1021B-786C-4538-8883-70A1C6754034" action="update">
<status>WARNING</status>
<description>The asset has been saved successfully. Some attributes were not saved due to Access Rights</description>
</response>
</responses>
</pim>Query assets
| /dam/assets/query Gets list of asset tids by allowed criteria |
Allows to get assets tids by:
-
By modification date (from/until)
-
By file type
-
By directory
Tip: Criteria combined with AND operator.
Resource path |
/api/core/v1/dam/assets/query |
HTTP method |
POST |
Request content type |
application/json; |
Response content type |
application/json; |
Body parameters
Accepts AssetQuery
Return Type
Filled with asset tids AssetRequest
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found assets ids |
|
400 |
Invalid input error ResponseType |
|
500 |
Error in ResponseType |
Samples
Query asset by modified dates, asset discriminator, parent directory
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/query' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"modifiedFrom": "2022-12-09T08:33:09.734Z",
"modifiedUntil": "2022-12-12T08:33:09.734Z",
"fileTypes": [
"IMG"
],
"directory": {
"path": "/MAM/dir1/dir2/dir3"
}
}
'Request body examples:
Request assets with type IMG, in specified directory limited by modification dates range
{
"modifiedFrom": "2022-12-09T08:33:09.734Z",
"modifiedUntil": "2022-12-12T08:33:09.734Z",
"fileTypes": [
"IMG"
],
"directory": {
"path": "/MAM/dir1/dir2/dir3"
}
}Request asset in directory by tid
{
"directory": {
"tid": "DBF6D18D-6CB4-4765-8966-10000DD22A6E"
}
}Request asset in directory by id
{
"directory": {
"id": 74628354
}
}Request asset in directory by path
{
"directory": {
"path": "/MAM/rootDirectory/childDirectory"
}
}Response body
{
"tids": [
"8E93BA7A-0521-4FB2-A7B7-40941C7A5AFA",
"218BCAED-A63B-4CE4-B23F-42B479E4E9FB",
"C3617CA4-0869-4A60-9CDC-32DCA0322F63",
"2BA8E460-964E-4197-9292-1E4365B29386",
"5BD22A27-7C2E-49B9-B90F-00F209900480",
"A168315F-24BF-4EF3-8BF9-619C71502D42",
"C9229729-D0D6-4CDA-92C8-3B916D1B4F85",
"2ABE86E5-6261-4BBF-A30B-235964B6EDBD",
"365F8ED1-1B75-4218-824A-E0B394D1DFEE",
"2312639C-F5D7-4F82-BEEF-4DD5E9668425",
"8195578A-AB9D-4BFD-9B86-2519E0A74E85",
"FC2E1C48-5904-4754-9E4E-8032ABE6949C",
"599641D5-7637-46DB-97BC-635F915C188A",
"D1019EE5-F1E0-49FA-8C2B-AD7FE3F8402C",
"6BD4B93B-2F35-4B9F-909E-974443B7C96B",
"DA32F94E-98B8-4F62-B588-EE804D97717B",
"08E3AF9C-1D28-4962-9C82-4E54633A9A4B",
"F008FE89-7372-4C17-83AB-670A664B57D9",
"95E7D312-1C4B-43BF-93C9-2219248ABF33",
"A905D075-8312-49EA-AB09-65D6FDBEE573",
"19F2C143-68D0-410C-BC24-53B33B70D270"
],
"retrieveHistory": false,
"retrievePreviews": false
}Retrieve statuses of an assets
| /dam/assets/status Gets the status information for given assets. |
The endpoint could provide information about asset import and object statuses.
Resource path |
/api/core/v1/dam/assets/status |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by AssetRequest
-
ids: it might be used to get assets statuses by asset’s id's
-
tids: it might be used to get assets statuses by asset’s tid's
| Assets statuses are retrieved by tids OR ids. ids are ignored if the request contains tids and ids. |
Return Type
OmnType with filled AssetsType. More info AssetType
Responses
| Value | Description |
|---|---|
pending |
Import is in processing queue |
running |
General status if import is running |
available |
Asset, previews and metadata available |
incomplete |
Import failed at some state and is incomplete (most of the time Asset is available but not synchronized) |
| Value | Description |
|---|---|
import incomplete |
Object is not synchronized (check-in not complete) |
available |
Asset, previews and metadata available after import/checkin |
locked |
Asset is "checked out" |
marked for deletion |
Asset is marked for deletion |
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled AssetsType |
|
400 |
Invalid input provided |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
1. To get a list of assets statuses by assets tids
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/status' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"tids": ["986A971D-1B8B-4E72-ACB3-0ED272CB504"]
}'Request body
{
"tids": ["986A971D-1B8B-4E72-ACB3-0ED272CB504"]
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-09-27T12:41:38.795Z</itm>
<itm key="itemInformationType">asset</itm>
</meta>
<assets>
<asset tid="986A971D-1B8B-4E72-ACB3-0ED272CB504" id="64556">
<meta>
<itm key="ImportState">available</itm>
<itm key="ObjectState">available</itm>
</meta>
</asset>
</assets>
</pim>2. To get a list of assets statuses by assets ids
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/status' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ids": ["15185"]
}'Request body
{
"ids": ["15185"]
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-09-27T12:41:38.795Z</itm>
<itm key="itemInformationType">asset</itm>
</meta>
<assets>
<asset tid="986A971D-1B8B-4E72-ACB3-0ED272CBCCC" id="15185">
<meta>
<itm key="ImportState">available</itm>
<itm key="ObjectState">available</itm>
</meta>
</asset>
</assets>
</pim>Retrieve Histories
| /dam/assets/histories/retrieve Retrieve asset histories by specified path. |
Resource path |
/api/core/v1/dam/assets/histories/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by HistoryRequest
-
tids - (List of String) - Filter parameter, asset TIDs (Metatag GUID), identifying unique objects
-
ids - (List of Integer) - Filter parameter, asset IDs, identifying unique objects
-
paths - (List of String) - Filter parameter, asset paths, identifying unique objects
Return Type
OmnType with filled HistoriesType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with list of histories |
|
404 |
The requested resource could not be found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Retrieve history for assets by tids/ids/paths
Request body:
by tids
{
"tids": ["71A1021B-786C-4538-8883-70A1C6754034", "5FB0C015-2937-4B5C-AD45-7E7A49EEF026"]
}by ids
{
"ids": [25151, 25167]
}by path
{
"paths": ["/MAM/test/invisible/image1.png", "/MAM/test/simple/image2.png"]
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-05-24T06:45:03.459Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<assets>
<asset tid="71A1021B-786C-4538-8883-70A1C6754034">
<name>image1.png</name>
<meta>
<itm key="identity">25151</itm>
<itm key="pathStringStr">MAM/test/invisible/image1.png</itm>
</meta>
<histories>
<history id="98765">
<itm key='changedProperty'>prop1</itm>
<itm key='eventDate'>02.02.2022</itm>
<itm key='eventDescription'>Description</itm>
<itm key='eventIdentifier'>SAVE_DETAILS</itm>
<itm key='newValue'>NewText</itm>
<itm key='oldValue'>OldText</itm>
<itm key='userIdentifier'>admin</itm>
</history>
</histories>
</asset>
<asset tid="5FB0C015-2937-4B5C-AD45-7E7A49EEF026">
<name>image2.png</name>
<meta>
<itm key="identity">25167</itm>
<itm key="pathStringStr">MAM/test/simple/image2.png</itm>
</meta>
<history id="54321">
<itm key='changedProperty'>prop2</itm>
<itm key='eventDate'>02.02.2022</itm>
<itm key='eventDescription'>Description</itm>
<itm key='eventIdentifier'>SAVE_DETAILS</itm>
<itm key='newValue'>future</itm>
<itm key='oldValue'>past</itm>
<itm key='userIdentifier'>user</itm>
</history>
</histories>
</asset>
</assets>
</pim>Versions API
Provides operations on OMN assets version and related version information.
Version chunked upload. Start
| /dam/assets/versions/bin/chunked/start Initialize chunk upload session for the version file. |
Initialize chunk upload session for the file
Version chunk upload workflow consist from 3 general steps like the asset upload:
|
|
Resource path |
/api/core/v1/dam/assets/versions/bin/chunked/start |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by AssetVersionUploadRequest
| tid - is required and refers to asset for which version file will be uploaded. |
Return Type
PimType with filled ResponsesType
Response type contains upload tid - the unique identity of the upload session. Upload tid is required for next upload steps.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input provided |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Start upload session
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin/chunked/start' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"tid": "0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
}'Request body AssetVersionUploadRequest
{
"tid":"0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
}Response body. With upload tid.
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response tid="614cde94-fdd6-47aa-86e6-c090d900032c">
<status>SUCCESS</status>
<description>Version chunk upload could be started by upload UUID/tid</description>
</response>
</responses>
</pim>Error responses
No asset by tid
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">8dbfd28d-9487-4c6c-a878-9f30557f2e1b</itm>
</details>
<issues>
<itm key="code">1002</itm>
<itm key="description">The requested resource could not be found</itm>
<itms type="details">
<itm key="errorMessage">Isy object with meta tag guid '0AA31C0C-F2AE-422C-9C6A-25BAB368706E' is not found.</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="update"
dataType="asset"
tid="0AA31C0C-F2AE-422C-9C6A-25BAB368706E">
<status>ERROR</status>
<description>Asset is not available by access rights</description>
</response>
</responses>
</pim>Version chunked upload. Upload a chunk
| /dam/assets/versions/bin/chunked/upload/{uploadTid} Upload a specified chunk of an asset. |
| Upload session must be started before a chunk upload. |
Resource path |
|
HTTP method |
POST |
Request content type |
multipart/form-data |
Response content type |
|
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
uploadTid |
The session identifier of the started chunked upload. |
X |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
chunkId |
Identity of an asset chunk which should be uploaded |
X |
Int32. Positive numbers starting from 0. |
|
payload |
Blob file |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Upload a chunk
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin/chunked/upload/614cde94-fdd6-47aa-86e6-c090d900032c' \ --header 'Authorization: Bearer <TOKEN>' \ --form 'payload=@"<PATH_TO_FILE>500x500.jpg"' \ --form 'chunkId="0";type=application/json'
Response body. With upload status
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="create" id="0" tid="614cde94-fdd6-47aa-86e6-c090d900032c">
<status>SUCCESS</status>
<description>Chunk has been uploaded</description>
</response>
</responses>
</pim>Version chunked upload. Finish
| /dam/assets/versions/bin/chunked/persist/{uploadTid} Finalize the chunk upload of the asset version. |
Finalize the chunking upload of the asset version.
Upload as version feature will create a version for file that currently is on the system and then replace the file on the system with the uploaded.
| Some chunks should be uploaded before notifying the server that API consumer uploaded all chunks. |
Resource path |
|
HTTP method |
PUT |
Request content type |
application/json |
Response content type |
|
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
uploadTid |
The session identifier of the started chunked upload. |
X |
Body parameters
Specified by AssetVersionUploadRequest.
Version of the existing file will be created with provided parameters AssetVersionUploadRequest
It’s a finalization step for file version upload.
The AssetVersionUploadRequest's tid parameter should be the same as was sent for /dam/assets/versions/bin/chunked/start.
|
Return Type
PimType with filled ResponsesType
Response type contains status and info about asset that was uploaded to the system.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input provided |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Finalize upload session
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin/chunked/persist/614cde94-fdd6-47aa-86e6-c090d900032c' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"tid": "0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
"versionComment": "Created before upload via API",
"timeoutDate": "2022-09-07T09:16:09.171Z",
"protectedAfterDate": "2022-09-07T09:16:09.171Z",
"protectedBeforeDate": "2022-09-07T09:16:09.171Z",
}'Request body AssetVersionUploadRequest
{
"tid":"0AA31C0C-F2AE-422C-9C6A-25BAB368706E",
"versionComment": "Created before upload via API",
"timeoutDate": "{Date in the ISO8601 format}",
"protectedAfterDate": "{Date in the ISO8601 format}",
"protectedBeforeDate": "{Date in the ISO8601 format}"
}}Response body. With status and uploaded asset info
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="update"
dataType="asset"
tid="0AA31C0C-F2AE-422C-9C6A-25BAB368706E">
<status>SUCCESS</status>
<description>Old file has been versioned and new file has been uploaded</description>
</response>
</responses>
</pim>Error responses
It is possible, that during chunks upload, the target is not available.
No asset by tid
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.apollon.de/omn">
<details>
<itm key="supportId">8dbfd28d-9487-4c6c-a878-9f30557f2e1b</itm>
</details>
<issues>
<itm key="code">1002</itm>
<itm key="description">The requested resource could not be found</itm>
<itms type="details">
<itm key="errorMessage">Isy object with meta tag guid '0AA31C0C-F2AE-422C-9C6A-25BAB368706E' is not found.</itm>
</itms>
</issues>
<status>ERROR</status>
</response>No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<responses>
<response action="update"
dataType="asset"
tid="0AA31C0C-F2AE-422C-9C6A-25BAB368706E">
<status>ERROR</status>
<description>Asset is not available by access rights</description>
</response>
</responses>
</pim>Version upload
| /dam/assets/versions/bin/persist Upload asset as version to the system. |
Semantic is the same as in chunked version upload. Within this endpoint it’s possible to upload file per one request without splitting to chunks.
Upload as version feature will create a version for file that currently is on the system and then replace the file on the system with the uploaded.
Resource path |
|
HTTP method |
POST |
Request content type |
multipart/form-data |
Response content type |
|
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
params |
Version upload and creation parameters AssetVersionUploadRequest |
X |
||
payload |
Blob file |
X |
Return Type
PimType with filled ResponsesType
Response type contains status and info about upload asset version operation.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input provided |
|
404 |
No asset by tid |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Upload file version
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--form 'payload=@"/<FILE_PATH>/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500.jpg"' \
--form 'params="{\"versionComment\": \"Created before upload via API\", \"tid\":\"F103F147-428C-4427-AA65-8A46AE066803\"}";type=application/json'Request body AssetVersionUploadRequest
{
"tid":"F103F147-428C-4427-AA65-8A46AE066803",
"versionComment": "Created before upload via API",
"timeoutDate": "{Date in the ISO8601 format}",
"protectedAfterDate": "{Date in the ISO8601 format}",
"protectedBeforeDate": "{Date in the ISO8601 format}"
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-16T09:30:46.743Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="F103F147-428C-4427-AA65-8A46AE066803"
action="update">
<status>SUCCESS</status>
<description>Old file has been versioned and new file has been uploaded</description>
</response>
</responses>
</pim>Error response
No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-16T09:45:15.768Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="BA7A3E08-A48B-47FE-8150-6986A61588732"
action="update">
<status>ERROR</status>
<description>Asset is not available by access rights</description>
</response>
</responses>
</pim>Retrieve Binary Versions
| /dam/assets/versions/bin Retrieves the binary data of asset version. |
Resource path |
/api/core/v1/dam/assets/versions/bin |
HTTP method |
POST |
Request content type |
Request params |
Response content type |
application/octet-stream |
Body parameters
Specified by request URL params
-
assetTid - (String) - tid of asset
-
assetId - (Integer) - identity of asset
-
format - (String) - type of version preview
-
versionNumber - (Integer) - number of version
-
versionTid - (String) - tid of version
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with list of keywords |
|
404 |
The requested resource could not be found |
|
500 |
An unknown internal error occurred |
Samples
1. Retrieve binary version by assetId
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin?assetId=<ASSET_IDENTITY>&versionNumber=<VERSION_NUMBER>' \
--header 'Authorization: Bearer <TOKEN> ' \
--data-raw ''Request params:
assetId=12345, versionNumber=1Response body:
apollon_logo_original.png2. Retrieve binary version by assetTid
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin?assetTid=<ASSET_TID>&versionNumber=<VERSION_NUMBER>' \
--header 'Authorization: Bearer <TOKEN> ' \
--data-raw ''Request params:
assetId=B29ECF60-0AB0-431D-8510-94490F27B229, versionNumber=1Response body:
apollon_logo_original.png3. Retrieve version preview by version tid and preview type
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/assets/versions/bin?versionTid=<VERSION_TID>&format=<PREVIEW_FORMAT>' \
--header 'Authorization: Bearer <TOKEN> ' \
--data-raw ''Request params:
versionTid=B29ECF60-0AB0-431D-8510-94490F27B229, previewType=previewThumbnailResponse body:
thumbnail.pngVariations API
Provides operations on OMN asset variations.
Retrieve variations
| /dam/assets/variations/retrieve Retrieves asset variations. |
Variation object represents link between assets.
Resource path |
/api/core/v1/dam/assets/variations/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by VariationRequest
Return Type
OmnType with filled VariationsType. More info VariationType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with list of asset variations |
|
500 |
Error in ResponseType |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Get asset variations
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/variations/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"assetPaths": ["/MAM/demo/copies/tempAR/pcUXFux_77I.jpg", "/MAM/demo/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500_print_variation.jpg"]
}'Request body examples:
By assets ids
{
"assetIds": [12333]
}By assets tids
{
"assetTids": ["38043B75-5BB3-44CE-AFD1-401503C6F322"]
}By assets paths
{
"assetPaths": ["/RNC/Dir1/Dir2/file.jpg"]
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-09-01T11:41:47.507Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<variations>
<variation assetId="86430" assetTid="DB32DAAC-6A80-4BEB-A09C-C020CA941F4E"/>
<variation assetId="87960"
assetTid="C6E3F14B-092A-4267-9A5D-C16FE4295DC3"
parentTid="DB32DAAC-6A80-4BEB-A09C-C020CA941F4E">
<meta>
<itm key="variationType">Print</itm>
</meta>
</variation>
<variation assetId="87961"
assetTid="11319367-DE26-4FB8-9148-3C341766C1BA"
parentTid="C6E3F14B-092A-4267-9A5D-C16FE4295DC3">
<meta>
<itm key="variationType">Print</itm>
</meta>
</variation>
</variations>
</pim>Retrieve variation types
| /dam/assets/variations/types Retrieves asset variation types. |
Resource path |
/api/core/v1/dam/assets/variations/types |
HTTP method |
GET |
Response content type |
|
Return Type
OmnType with filled VariationTypesType. More info VariationTypeType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OmnType with filled VariationTypesType |
|
400 |
Invalid input provided |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Request examples
curl --location --request GET 'http://<OMN_SERVER>/api/core/v1/dam/assets/variations/types' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw ''Response example
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn">
<variationTypes>
<variationType tid="Print"/>
</variationTypes>
</pim>Upload as Variation
| /dam/assets/variations/bin/persist Upload file as variation to the system. |
Resource path |
|
HTTP method |
POST |
Request content type |
multipart/form-data |
Response content type |
|
Form Parameters
| AssetVariationUploadRequest.tid should be provided to the OMN asset. |
| Name | Description | Required |
|---|---|---|
params |
Upload parameters AssetVariationUploadRequest |
X |
payload |
Blob file |
X |
Return Type
PimType with filled ResponsesType
Response type contains status and info about uploaded asset variation.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled ResponsesType |
|
400 |
Invalid input |
|
404 |
The requested resource could not be found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
1. Upload a file as variation
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/variations/bin/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--form 'payload=@"/<FILE_PATH>/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500.jpg"' \
--form 'params="{
\"tid\":\"52F78637-63AE-4F3E-8D4B-664E070C6AB8\",
\"variationType\": \"Print\"
}";type=application/json'Request body AssetUploadRequest
{
"tid": "52F78637-63AE-4F3E-8D4B-664E070C6AB8",
"variationType": "Print"
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-16T09:30:46.743Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="variation"
tid="52F78637-63AE-4F3E-8D4B-664E070C6AB8"
action="update">
<status>SUCCESS</status>
<description>Asset variation has been created</description>
</response>
</responses>
</pim>2. Upload a file as variation with specified name
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/assets/variations/bin/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--form 'payload=@"/<FILE_PATH>/artworks-bQbImNIL55TZ52he-gAKJ7w-t500x500.jpg"' \
--form 'params="{
\"tid\":\"52F78637-63AE-4F3E-8D4B-664E070C6AB8\",
\"variationType\": \"Print\",
\"variationFileName\": \"assetVariation.png\"
}";type=application/json'Request body AssetUploadRequest
{
"tid": "52F78637-63AE-4F3E-8D4B-664E070C6AB8",
"variationType": "Print",
"variationFileName": "assetVariation.png"
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-16T09:30:46.743Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="variation"
tid="52F78637-63AE-4F3E-8D4B-664E070C6AB8"
action="update">
<status>SUCCESS</status>
<description>Asset variation has been created</description>
</response>
</responses>
</pim>Error response
No access to the asset
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-16T09:45:15.768Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="variation"
tid="52F78637-63AE-4F3E-8D4B-664E070C6AB8"
action="update">
<status>ERROR</status>
<description>Asset is not available by access rights</description>
</response>
</responses>
</pim>Directories API
Provides operations on OMN directories.
Retrieve directories
| /dam/dirs/retrieve Retrieves a list of sub-directories of the given RNC or directory. .Details |
Resource path |
/api/core/v1/dam/dirs/retrieve |
HTTP method |
POST |
Request content type |
application/json |
Response content type |
|
Body parameters
Specified by DirectoryRequest
-
rncTid: it might be used to get a top level directories within the given RNC
-
dirTid: it might be used to get a list of directories
-
dirPath: it might be used to get a list of directories
-
level: it sets how many directory level should be loaded Default value is 1. "-1" means to load all levels. 0 (zero) - is invalid value
Return Type
PimType with filled DirectoriesType. More info DirectoryType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with filled DirectoriesType |
|
400 |
Invalid input provided |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
1. To get a list of directories of a given RNC using rncTid parameter
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"rncTid": "MAM",
"level": 1
}'Request body
{
"rncTid": "MAM",
"level": 1
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<dirs>
<dir tid="tid1" rnc="DATA">
<name>directory1</name>
<meta>
<itm key="discriminator">DIR</itm>
<itm key="identity">26576991</itm>
<itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
<itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
</meta>
</dir>
<dir tid="tid2" rnc="DATA">
<name>directory2</name>
<meta>
<itm key="discriminator">DIR</itm>
<itm key="identity">26576992</itm>
<itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
<itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
</meta>
</dir>
</dirs>
</pim>2. To get a list of directories of a given RNC using dirPath parameter
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"dirPath": "/DATA",
"level": 1
}'Request body
{
"dirPath": "/DATA",
"level": 1
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<dirs>
<dir tid="tid1" rnc="DATA">
<name>directory1</name>
<meta>
<itm key="discriminator">DIR</itm>
<itm key="identity">26576991</itm>
<itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
<itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
</meta>
</dir>
<dir tid="tid2" rnc="DATA">
<name>directory2</name>
<meta>
<itm key="discriminator">DIR</itm>
<itm key="identity">26576992</itm>
<itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
<itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
</meta>
</dir>
</dirs>
</pim>3. To get a list of sub-directories of a directory by dirTid parameter:
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"dirTid": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
"level": 1
}'Request body
{
"dirTid": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
"level": 1
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<dirs>
<dir tid="tid1" parent="tid0">
<name>directory1</name>
<meta>
...
</meta>
</dir>
<dir tid="tid1.1" parent="tid1">
<name>directory1.1</name>
<meta>
...
</meta>
</dir>
<dir tid="tid2" parent="tid0">
<name>directory2</name>
<meta>
...
</meta>
</dir>
</dirs>
</pim>4. To get a list of sub-directories of a directory by dirPath parameter:
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"dirPath": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
"level": 1
}'Request body
{
"dirPath": "/DATA/assets",
"level": 1
}Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<dirs>
<dir tid="tid1" parent="tid0">
<name>directory1</name>
<meta>
...
</meta>
</dir>
<dir tid="tid1.1" parent="tid1">
<name>directory1.1</name>
<meta>
...
</meta>
</dir>
<dir tid="tid2" parent="tid0">
<name>directory2</name>
<meta>
...
</meta>
</dir>
</dirs>
</pim>Persist directories
| /dam/dirs/persist Persist a list of directories. |
Resource path |
/api/core/v1/dam/dirs/persist |
HTTP method |
POST |
Request content type |
|
Response content type |
|
Directory attributes
Directory attributes are stored in DirectoryType.vals
Directory attributes type and examples
| Attribute type | Is localized | Response template | Example |
|---|---|---|---|
Boolean |
|
|
|
Boolean |
X |
|
|
Date |
|
|
|
Date |
X |
|
|
Enumeration |
|
|
|
Enumeration |
X |
|
|
Number |
|
|
|
Number |
X |
|
|
String |
|
|
|
String |
X |
|
|
Body parameters
PimType with DirectoriesType
Specified by DirectoryType
-
rnc: root node configuration
-
tid: unique identifier
-
parent: parent directory unique identifier
-
name: new directory name
| Directory attributes can be persisted in the same request with directory. See Directory attributes |
Return Type
PimType with filled ResponsesType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with list of successful or error ResponseTypes |
|
400 |
Invalid input provided |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
1. Create a directory:
1.1. Create in the given RNC
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir rnc="MAM">
<name>New directory</name>
</dir>
</dirs>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir rnc="MAM">
<name>New Directory</name>
</dir>
</dirs>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-05-13T16:20:23.420Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="7D534991-B623-418C-A7CB-A273C877A37D"
action="create">
<status>SUCCESS</status>
<description>The directory has been saved successfully</description>
</response>
</responses>
</pim>1.2. Create in the given parent directory
curl
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir parent="63FBCD05-4DB0-42D5-AB13-C87F3366CA82">
<name>New directory</name>
</dir>
</dirs>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir parent="483AAC0B-57F2-4B70-95F9-FF1DAD9AA9C6">
<name>New Directory</name>
</dir>
</dirs>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-05-13T16:20:23.420Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="7D534991-B623-418C-A7CB-A273C877A37D"
action="create">
<status>SUCCESS</status>
<description>The directory has been saved successfully</description>
</response>
</responses>
</pim>Error responses
Missing directory parameter 'name'
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Missing directory parameter 'name'"</description>
</response>
</responses>
</pim>2. Update a directory
2.1. Update in the given RNC
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir tid="7D534991-B623-418C-A7CB-A273C877A37D" rnc="MAM">
<name>Updated Directory</name>
</dir>
</dirs>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir tid="7D534991-B623-418C-A7CB-A273C877A37D" rnc="MAM">
<name>Updated Directory</name>
</dir>
</dirs>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-05-13T16:25:28.200Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="7D534991-B623-418C-A7CB-A273C877A37D"
action="update">
<status>SUCCESS</status>
<description>The directory has been saved successfully</description>
</response>
</responses>
</pim>2.2. Update in the parent directory
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/persist' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir tid="41A7CF7F-60DA-4F76-8288-D9721389812A" parent="778B4AFD-6EC5-45D8-95B4-DA2213243B77">
<name>Updated Directory</name>
</dir>
</dirs>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<dirs>
<dir tid="41A7CF7F-60DA-4F76-8288-D9721389812A" parent="778B4AFD-6EC5-45D8-95B4-DA2213243B77">
<name>Updated Directory</name>
</dir>
</dirs>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-05-13T16:25:28.200Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="7D534991-B623-418C-A7CB-A273C877A37D"
action="update">
<status>SUCCESS</status>
<description>The directory has been saved successfully</description>
</response>
</responses>
</pim>Error responses
Move directory to itself or to the parent directory
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="update">
<status>ERROR</status>
<description>"Target directory is itself or target parent directory"</description>
</response>
</responses>
</pim>Missing directory parameter 'name' when updating
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="update">
<status>ERROR</status>
<description>Missing directory parameter 'name'</description>
</response>
</responses>
</pim>Common error responses
Directory attributes missing
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Directory attributes missing: 'rnc' or 'parent' attribute must be</description>
</response>
</responses>
</pim>Directory attributes mismatched
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>There must be only one of the attributes - 'rnc' or 'parent'</description>
</response>
</responses>
</pim>Permissions missing
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Permissions missing for directory with tid '7D534991-B623-418C-A7CB-A273C877A37D'</description>
</response>
</responses>
</pim>RNC not found
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Cannot find RNC with identifier 'MAM'</description>
</response>
</responses>
</pim>Directory already exists
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Directory with name 'Directory' already exists</description>
</response>
</responses>
</pim>Parent directory not found
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>Directory not found</description>
</response>
</responses>
</pim>File Management Synchronizer error
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="create">
<status>ERROR</status>
<description>File Management Synchronizer error</description>
</response>
</responses>
</pim>Directory not found
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-06T11:45:41.247Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="update">
<status>ERROR</status>
<description>Cannot find directory with tid '7D534991-B623-418C-A7CB-A273C877A37D'</description>
</response>
</responses>
</pim>Perform directories
| /dam/dirs/perform Perform action of the specific type on directory |
Resource path |
/api/core/v1/dam/dirs/perform |
HTTP method |
POST |
Request content type |
|
Response content type |
|
Body parameters
PimType with filled ActionsType
Provided ActionTypes must have the following fields:
-
Data type: dir;
-
tid, id or path of directory;
-
Action type: delete, move, copy, createPath.
Return Type
PimType with filled ResponsesType
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with list of successful or error ResponseTypes |
|
400 |
Invalid input provided |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
1. Delete directory
1.1. Delete by tid
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T10:10:16.774Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="730DD2AE-3AEA-4A13-9C3A-C6EC3C94ADCE" type="delete"/>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T10:10:16.774Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="730DD2AE-3AEA-4A13-9C3A-C6EC3C94ADCE" type="delete"/>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-12-09T11:39:25.555Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="51F78647-63AE-4F3E-8D4B-664E070C6AA2"
action="delete">
<status>SUCCESS</status>
<description>The directory has been deleted successfully</description>
</response>
</responses>
</pim>2. Move directory
2.1. Move by tid
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="E769ABBC-9AFC-47F2-8983-8DB40610937B" type="move">
<meta>
<itm key="destinationDirTid">EEB36E10-5B45-492A-BAB5-5737DDCC9B12</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="E769ABBC-9AFC-47F2-8983-8DB40610937B" type="move">
<meta>
<itm key="destinationDirTid">EEB36E10-5B45-492A-BAB5-5737DDCC9B12</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:22:10.069Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="E54AC373-09D8-478D-B201-9775D046EF4F"
id="23902"
action="move"
path="/MAM/dirToMove">
<status>SUCCESS</status>
<description>dir has been moved</description>
<details>
<itm key="monitorId">23955</itm>
</details>
</response>
</responses>
</pim>2.2. Move by id
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" id="23901" type="move">
<meta>
<itm key="destinationDirId">23900</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" id="23901" type="move">
<meta>
<itm key="destinationDirId">23900</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:22:10.069Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="E54AC373-09D8-478D-B201-9775D046EF4F"
id="23902"
action="move"
path="/MAM/dirToMove">
<status>SUCCESS</status>
<description>dir has been moved</description>
<details>
<itm key="monitorId">23955</itm>
</details>
</response>
</responses>
</pim>2.3. Move by path
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" path="/MAM/dirToMove" type="move">
<meta>
<itm key="destinationDirPath">/MAM/destinationDir</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" path="/MAM/dirToMove" type="move">
<meta>
<itm key="destinationDirPath">/MAM/destinationDir</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:22:10.069Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="E54AC373-09D8-478D-B201-9775D046EF4F"
id="23902"
action="move"
path="/MAM/dirToMove">
<status>SUCCESS</status>
<description>dir has been moved</description>
<details>
<itm key="monitorId">23955</itm>
</details>
</response>
</responses>
</pim>Error responses
Destination directory does not exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:27:00.349Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="move" path="/MAM/dirToMove">
<status>ERROR</status>
<description>The directory does not exist</description>
</response>
</responses>
</pim>No access to destination directory
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T07:00:03.303Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="4E1D4697-5085-4BDA-80CE-8DDCEAA9E584"
id="23905"
action="move"
path="/MAM/dirToMove">
<status>ERROR</status>
<description>Error during moving: No access to destination object '/destinationDir'</description>
</response>
</responses>
</pim>Collision during move
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:22:10.069Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="E54AC373-09D8-478D-B201-9775D046EF4F"
id="23902"
action="move"
path="/MAM/dirToMove">
<status>ERROR</status>
<description>Collision during move. Collision dir name:'dirToMove'</description>
<details>
<itm key="collision">true</itm>
<itm key="monitorId">77835</itm>
</details>
</response>
</responses>
</pim>3. Copy directory
3.1. Copy by tid
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="957836F4-840A-492B-B149-9720D177BC56" type="copy">
<meta>
<itm key="destinationDirTid">957836F4-840A-492B-B149-9720D177BC59</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" tid="957836F4-840A-492B-B149-9720D177BC56" type="copy">
<meta>
<itm key="destinationDirTid">957836F4-840A-492B-B149-9720D177BC59</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-19T11:54:34.959Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="957836F4-840A-492B-B149-9720D177BC56"
id="72030"
action="copy"
path="/MAM/demo/copies/tempAR">
<status>SUCCESS</status>
<description>dir has been copied</description>
<details>
<itm key="monitorId">79851</itm>
</details>
</response>
</responses>
</pim>3.2. Copy by id
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" id="3221749" type="copy">
<meta>
<itm key="destinationDirId">2376394</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" id="3221749" type="copy">
<meta>
<itm key="destinationDirId">2376394</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-19T11:54:34.959Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="957836F4-840A-492B-B149-9720D177BC56"
id="72030"
action="copy"
path="/MAM/demo/copies/tempAR">
<status>SUCCESS</status>
<description>dir has been copied</description>
<details>
<itm key="monitorId">79851</itm>
</details>
</response>
</responses>
</pim>3.3. Copy by path
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/perform' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" path="/MAM/demo/copies/tempAR" type="copy">
<meta>
<itm key="destinationDirPath">/MAM/</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>'Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-08T12:54:32.990Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<actions>
<action dataType="dir" path="/MAM/demo/copies/tempAR" type="copy">
<meta>
<itm key="destinationDirPath">/MAM/</itm>
<itm key="overwrite">false</itm>
</meta>
</action>
</actions>
</pim>Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-19T11:54:34.959Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="957836F4-840A-492B-B149-9720D177BC56"
id="72030"
action="copy"
path="/MAM/demo/copies/tempAR">
<status>SUCCESS</status>
<description>dir has been copied</description>
<details>
<itm key="monitorId">79851</itm>
</details>
</response>
</responses>
</pim>Error responses
Destination directory does not exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T06:27:00.349Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir" action="copy" path="/MAM/dirToCopy">
<status>ERROR</status>
<description>The directory does not exist</description>
</response>
</responses>
</pim>No access to destination directory
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T07:00:03.303Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="4E1D4697-5085-4BDA-80CE-8DDCEAA9E584"
id="23905"
action="copy"
path="/MAM/dirToCopy">
<status>ERROR</status>
<description>Error during moving: No access to destination object '/destinationDir'</description>
</response>
</responses>
</pim>Collision during copy
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-19T12:46:31.213Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="957836F4-840A-492B-B149-9720D177BC56"
id="72030"
action="copy"
path="/MAM/demo/copies/tempAR">
<status>ERROR</status>
<description>Collision during copy. Collision dir name:'tempAR'</description>
<details>
<itm key="collision">true</itm>
<itm key="monitorId">79856</itm>
</details>
</response>
</responses>
</pim>3. Create path (multiple directories)
3.1. Create by path
Request body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<actions>
<action dataType="dir" path="/MAM/test2/1" type="createPath"/>
</actions>
</pim>Response body (Info about the last/deepest created directory only)
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2023-10-19T11:35:25.013Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response action="create" dataType="dir" tid="0E680AA4-5749-46FB-8A46-02282E37BAC1">
<description>The directory has been saved successfully</description>
<status>SUCCESS</status>
</response>
</responses>
</pim>Common error responses
Directory does not exist
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T13:36:54.983Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE2"
action="delete">
<status>ERROR</status>
<description>Cannot find directory with tid '37590039-3AEA-4A13-9C3A-C6EC3C94ADCE2'</description>
</response>
</responses>
</pim>Wrong request data type
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-06-04T13:38:16.444Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="asset"
tid="37590039-3AEA-4A13-9C3A-C6EC3C94ADCE2"
action="delete">
<status>ERROR</status>
<description>The data type of the passed item is wrong. It must be 'dir'</description>
</response>
</responses>
</pim>No access to directory
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-08-18T07:04:12.515Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<responses>
<response dataType="dir"
tid="4E1D4697-5085-4BDA-80CE-8DDCEAA9E584"
id="23905"
action="move"
path="/MAM/dirToMove">
<status>ERROR</status>
<description>Error during moving: No access to source objects</description>
</response>
</responses>
</pim>RNCs API
Provides operations on OMN Root nodes configurations.
Retrieve RNCs
| /dam/rncs/retrieve Returns all Root Node Configurations [RNC]. |
Resource path |
/api/core/v1/dam/rncs/retrieve |
HTTP method |
POST |
Request content type |
|
Response content type |
|
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PimType with list of RNCs |
|
404 |
The requested resource could not be found |
|
500 |
An unknown internal error occurred |
Samples
| Please use transform endpoint to get the JSON/compact-JSON samples from the XML one. |
Retrieve RNCs
curl
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/rncs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw ''Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
<meta>
<itm key="messageType">request</itm>
<itm key="messageTime">2022-07-18T03:46:11.950Z</itm>
<itm key="sourceEnv">web</itm>
</meta>
<rncs>
<rnc tid="MAM">
<meta>
<itm key="rncCreationDate">2022-01-13T05:34:43.262Z</itm>
<itm key="rncDisablePreviewGeneration">false</itm>
<itm key="rncEventBasePath">/localhost/omn/data/MAM/</itm>
<itm key="rncIdentifier">MAM</itm>
<itm key="rncIdentity">15030</itm>
<itm key="rncLocalPathAsString">/omn/data/MAM/</itm>
<itm key="rncModificationDate">2022-01-13T05:34:43.262Z</itm>
<itm key="rncOriginalMaxSize">1280x1024</itm>
<itm key="rncOriginalResolution">72</itm>
<itm key="rncPdfFirstPagePreviewOnly">false</itm>
<itm key="rncUseResolution">false</itm>
<itm key="rncVolumeName">MAM</itm>
<itm key="rndDisableEvents">false</itm>
<itm key="serverDescription"/>
<itm key="serverHost">localhost</itm>
<itm key="serverIdentifier">localhost</itm>
<itm key="serverIdentity">15020</itm>
<itm key="serverPort">6900</itm>
</meta>
</rnc>
</rncs>
</pim>