Experience API and DAM - Set access on collections

HCL Digital Experience Digital Experience Forum
,
1

Hi!
We are testing the DAM-part of the Experience API and have a question if it's possible to set access on a collection through the API? We can't seem to find a way to do that with the API but it's possible through the gui and I'll recall that HCL has stated that most of what you can do in the gui should be possible to do with the API?

Thanks!

2

Please refer to this link for details on APIs...

https://github.com/hcl-dx/experience-api-documentation

The above link also points here...

https://hcl-dx.github.io/experience-api-documentation/ring-api/

3

Yes, thanks but I have gone through those as well as the api on the server but the problem is that I can't find anything that sets access on the collections in DAM.

4

Hi Johan,

You can review the current DAM APIs available directly on your DAM API service:

https://<hostname>>/dx/api/dam/v1/explorer/

For the Collections API, we do not have a way to set access on a Collection with our current APIs (CF191). Please submit a feature request for this functionality here:

https://www.hcltechsw.com/resources/submit-idea

Thank you,

Oscar

5

Thanks Oscar!
That was what I suspected but just wanted to be sure.

6

Sure thing Johan. You're welcome.

Oscar

7

Hello Oscar,

well, this requirement was discussed serveral times. Last time in Milanp 2019. There is an idea open for this: https://dx-ideas.hcltechsw.com/ideas/WCM-I-8 and if you see the comments it is required to make that scriptable too. Guess it is enough to stick to that?

8

Hello Johan,

Based on the API documentation, you can use the AccessControlController API. This is documented here:

https://hcl-dx.github.io/experience-api-documentation/ring-api/#tag/AccessControlController

To get this to work with DAM collections, pass in the collection ID for the resource ID when using any AccessControlController API calls.

This is also possible in the UI - documented below:

https://help.hcltechsw.com/digital-experience/9.5/digital_asset_mgmt/manage_collections.html

Look for the section titled: Manage user access permissions of a media asset collection

"From the HCL Digital Experience 9.5 Digital Asset Management interface, hover over a collection and click the Access tab.
Assign levels for other users to access media items stored within the Collection."

Edit: I took a second look at your question and you already know that this is possible with the UI - I hope this answer provides assistance to those who have a similar problem, though!

Edit 2: corrected incomplete information and shared API documentation that accomplishes access control updates for DAM collections.

9

Hello @Johan Bladh,

Upon further review, you can retrieve and update and create access control permissions for DAM collections with the AccessControlController API, documented at this link.

https://hcl-dx.github.io/experience-api-documentation/ring-api/#tag/AccessControlController

To make this work with DAM collections, you can pass the collection id for any AccessControlController calls with resource id as a parameter.

I am also going to correct my earlier updates to reflect this answer. Please review and try out this API and let us know if you have any questions!

Best,

Jack Derbyshire