CS 16.2 REST API - How to get Personal Workspace info for a user?

Hi all,

I am rather new to the CS world, and having been working to get some scripts developed to execute various things via the REST API (if possible). One of the things I have been asked to look at is using the REST API to get information about a given user's Personal Workspace, and additionally (if possible), enable or disable the ability of a user to change permissions in their personal workspace.

I have successfully authenticated, and made a couple calls against REST endpoints, but I have no idea how to get information about the personal workspace of a given user.

Would anyone be able to give me a nudge in the right direction (or let me know if it is not doable via the REST API)?

Cheers,

Keith.

Find more posts tagged with

Comments

Appu Nair

There might be a proper way but most experienced Livelinknée CS users know that a users Id is KUAF.ID and that happens to be

the ID (-ownerID in DTree for the Personal Workspace)

so the real relation is

select * from DTree where DataID=

(select ID from KUAF where Name like 'kcq657') and SubType=142 /* for personal workspace/*

All Objects in a personal workspace is actually "owned" by that ID so

select * from DTree where OwnerID=-8766002

it just happens OT uses -OwnerID to do that

when I hovered over the SmartUI app on my personal workspace it showed

/otcs/llisapi.dll/app/nodes/8766002 which happens to be my KUAF.ID in that system

perhaps this will give you a start...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Wednesday, April 3, 2019 12:39:17 PM
To: eLink Recipient
Subject: CS 16.2 REST API - How to get Personal Workspace info for a user?

CS 16.2 REST API - How to get Personal Workspace info for a user?

Posted by keith.young2@canada.ca (Young, Keith) On 04/03/2019 01:35 PM

Hi all,I am rather new to the CS world, and having been working to get some scripts developed to execute various things via the REST API (if possible). One of the things I have been asked to look at is using the REST API to get information about a given user's Personal Workspace, and additionally (if possible), enable or disable the ability of a user to change permissions in their personal workspace.I have successfully authenticated, and made a couple calls against REST endpoints, but I have no idea how to get information about the personal workspace of a given user. Would anyone be able to give me a nudge in the right direction (or let me know if it is not doable via the REST API)?Cheers,Keith.

[To post a comment, use the normal reply function]
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

Confidentiality Note: This message contains information, which may be privileged or confidential, or exempt from disclosure under applicable law. If the reader of this message is not the intended recipient, or the employee responsible for delivering the message to the intended recipient, you are hereby NOTIFIED that any dissemination, distribution, retention, archiving, or copying of this communication is strictly prohibited. If you receive this message in error, please notify sender immediately.

Appu Nair

There might be a proper way but most experienced Livelinknée CS users know that a users Id is KUAF.ID and that happens to be

the ID (-ownerID in DTree for the Personal Workspace)

so the real relation is

select * from DTree where DataID=

(select ID from KUAF where Name like 'kcq657') and SubType=142 /* for personal workspace/*

All Objects in a personal workspace is actually "owned" by that ID so

select * from DTree where OwnerID=-8766002

it just happens OT uses -OwnerID to do that

when I hovered over the SmartUI app on my personal workspace it showed

/otcs/llisapi.dll/app/nodes/8766002 which happens to be my KUAF.ID in that system

perhaps this will give you a start...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

CS 16.2 REST API - How to get Personal Workspace info for a user?

Posted by keith.young2@canada.ca (Young, Keith) On 04/03/2019 01:35 PM

[To post a comment, use the normal reply function]
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

Nizar Ghazal

Hi Keith,

Well, the first hurdle I figure for you, would be to programmatically figure out what DataID a given user's workspace would have, right? (I'm going to assume that you're strictly forbidden from being able to run any SQL or LiveReports to find things out):

So, a personal workspace has a special Subtype, 142. Subtypes are just numerical representations as the kind of object something is, in Content Server. 0 is a folder, 144 is a document, 749 is an email services email, etc.

Content Server search can index things based on SubType, and I think it's called OTSubtype when you want to search for a given SubType.

You could first POST against api/v2/search looking for a person's name + Subtype 142, which should hopefully net you the unique ID for a given workspace. You may need to poke your search admin about allowing indexing of subtype with objects, or at least setting it to be queryable, if it was disabled.

Now, once you have their workspace location, get the contents:

GET /api/v1/nodes/<workspaceID>/nodes

Now you have all the items, therein.

Now, you may be curious as to how other sorts of elements are returned, right?
My easy-mode for figuring out how to work with REST API is to do the following:

1) Find the closest equivalent action I need, via the regular SmartUI View (You wanted to set permissions, right? Do it on your own workspace while you run Fiddler).

2) Startup Fiddler/Wireshark

3) See precisely what end-points it hits, for what, and how exactly it's formatted.

Then that's about it.

Regards,

Nizar

AKropp

To extrapolate from this, you can use api/v2/members to get the user ID you’re interested in, then api/v2/nodes/<id> to get information about the workspace and api/vs/nodes/<id>/permissions to manipulate that.

That said I tried step 2 of locking out a user from their own workspace either by removing owner or by revoking individual perms and my test user can no longer log in at all. Even just See/See Contents resulted in a “Could not get the EWS” error page so that part may not be the way to go about this. Not sure what the alternative is in that regard…

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Wednesday, April 3, 2019 2:37 PM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

[EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted byanair@alitek.com (Nair, Appu) On 04/03/2019 02:36 PM

There might be a proper way but most experienced Livelinknée CS users know that a users Id is KUAF.ID and that happens to be

the ID (-ownerID in DTree for the Personal Workspace)

so the real relation is

select * from DTree where DataID=

(select ID from KUAF where Name like 'kcq657') and SubType=142 /* for personal workspace/*

All Objects in a personal workspace is actually "owned" by that ID so

select * from DTree where OwnerID=-8766002

it just happens OT uses -OwnerID to do that

when I hovered over the SmartUI app on my personal workspace it showed

/otcs/llisapi.dll/app/nodes/8766002 which happens to be my KUAF.ID in that system

perhaps this will give you a start...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

CS 16.2 REST API - How to get Personal Workspace info for a user?

Posted bykeith.young2@canada.ca (Young, Keith) On 04/03/2019 01:35 PM

Hi all,

I have successfully authenticated, and made a couple calls against REST endpoints, but I have no idea how to get information about the personal workspace of a given user.

Would anyone be able to give me a nudge in the right direction (or let me know if it is not doable via the REST API)?

Cheers,

Keith.

[To post a comment, use the normal reply function]
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

Appu Nair

Perhaps AK it may have some bearing in this

DefaultRH=enterprise.home

DefaultContentRH=Enterprise.Home //that looks from the old java days is it even getting used now?

If someone hadn't set this it would default the standard URL to Enterprise?

I went into my CS16 and changed my settings to always take me to my PWS. If my PWS was not permission I would probably get that message?

Just a thought...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Wednesday, April 3, 2019 2:01:07 PM
To: eLink Recipient
Subject: RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted by akropp@opentext.com (Kropp, Alex) On 04/03/2019 03:00 PM

To extrapolate from this, you can use api/v2/members to get the user ID youre interested in, then api/v2/nodes/<id> to get information about the workspace and api/vs/nodes/<id>/permissions to manipulate that. That said I tried step 2 of locking out a user from their own workspace either by removing owner or by revoking individual perms and my test user can no longer log in at all. Even just See/See Contents resulted in a Could not get the EWS error page so that part may not be the way to go about this. Not sure what the alternative is in that regard AK From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Wednesday, April 3, 2019 2:37 PM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

[EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted byanair@alitek.com (Nair, Appu) On 04/03/2019 02:36 PM

There might be a proper way but most experienced Livelinknée CS users know that a users Id is KUAF.ID and that happens to be

the ID (-ownerID in DTree for the Personal Workspace)

so the real relation is

select * from DTree where DataID=

(select ID from KUAF where Name like 'kcq657') and SubType=142 /* for personal workspace/*

All Objects in a personal workspace is actually "owned" by that ID so

select * from DTree where OwnerID=-8766002

it just happens OT uses -OwnerID to do that

when I hovered over the SmartUI app on my personal workspace it showed

/otcs/llisapi.dll/app/nodes/8766002 which happens to be my KUAF.ID in that system

perhaps this will give you a start...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

CS 16.2 REST API - How to get Personal Workspace info for a user?

Posted bykeith.young2@canada.ca (Young, Keith) On 04/03/2019 01:35 PM

Hi all,

I have successfully authenticated, and made a couple calls against REST endpoints, but I have no idea how to get information about the personal workspace of a given user.

Would anyone be able to give me a nudge in the right direction (or let me know if it is not doable via the REST API)?

Cheers,

Keith.

[To post a comment, use the normal reply function]
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

AKropp

Yeah, that sounds like you’re probably right. I’ve never really had to delve too much into the login process before.

Either way, sounds like Keith should be able to at least start experimenting with this stuff from here

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Wednesday, April 3, 2019 3:21 PM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: Re RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Re RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted byanair@alitek.com (Nair, Appu) On 04/03/2019 03:21 PM

Perhaps AK it may have some bearing in this

DefaultRH=enterprise.home

DefaultContentRH=Enterprise.Home //that looks from the old java days is it even getting used now?

If someone hadn't set this it would default the standard URL to Enterprise?

I went into my CS16 and changed my settings to always take me to my PWS. If my PWS was not permission I would probably get that message?

Just a thought...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted byakropp@opentext.com (Kropp, Alex) On 04/03/2019 03:00 PM

[EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted byanair@alitek.com (Nair, Appu) On 04/03/2019 02:36 PM

There might be a proper way but most experienced Livelinknée CS users know that a users Id is KUAF.ID and that happens to be

the ID (-ownerID in DTree for the Personal Workspace)

so the real relation is

select * from DTree where DataID=

(select ID from KUAF where Name like 'kcq657') and SubType=142 /* for personal workspace/*

All Objects in a personal workspace is actually "owned" by that ID so

select * from DTree where OwnerID=-8766002

it just happens OT uses -OwnerID to do that

when I hovered over the SmartUI app on my personal workspace it showed

/otcs/llisapi.dll/app/nodes/8766002 which happens to be my KUAF.ID in that system

perhaps this will give you a start...

Appu Nair
Principal Architect | Alitek
Website: alitek.com

CS 16.2 REST API - How to get Personal Workspace info for a user?

Posted bykeith.young2@canada.ca (Young, Keith) On 04/03/2019 01:35 PM

Hi all,

I have successfully authenticated, and made a couple calls against REST endpoints, but I have no idea how to get information about the personal workspace of a given user.

Would anyone be able to give me a nudge in the right direction (or let me know if it is not doable via the REST API)?

Cheers,

Keith.

[To post a comment, use the normal reply function]
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

*** CAUTION: This email originated from outside of ALITEK. Please do not click links or open attachments unless you know the sender and are confident the content is safe.

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

Keith_Young

Quoted Alex Kropp on 04/04/2019 01:21 PM:

Hi,

Thanks for the response (to everyone actually)...

I got some of it working, but there is some weirdness that I am experiencing. I can get the id of the user just fine and then the node for the user that is the Personal Workspace. However, when trying either of /api/v2/members/<ID> or /api/v2/nodes/<ID>/permissions I get an API error. The first screenshot below shows a successful call to /nodes/<ID>, and the second shows /nodes/<ID>/permissions.

Is this suggestive of something wrong with the API, or can the individual endpoints be disabled via configuration on the server?

Cheers,

Keith.

AKropp

Hi Keith,

Out of curiosity, what’s your full CS version? Could be an update level thing I suppose. You can find it by going to any page on your instance > ? menu > About Content Server.

I’m not entirely sure when the permissions stuff was added to the API. If you use v1 instead of v2 with members does that work? There’s no v1 for the permissions endpoint.

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Thursday, April 4, 2019 1:26 PM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

RE [EXTERNAL] - Re CS 16.2 REST API - How to get Personal Workspace info for a user? 2

Posted bykeith.young2@canada.ca (Young, Keith) On 04/04/2019 01:21 PM

Quoted Alex Kropp on 04/04/2019 01:21 PM:

Hi,

Thanks for the response (to everyone actually)...

Is this suggestive of something wrong with the API, or can the individual endpoints be disabled via configuration on the server?

Cheers,

Keith.

[To post a comment, use the normal reply function]
Topic:	CS 16.2 REST API - How to get Personal Workspace info for a user?
Forum:	Content Server Development Forum
Content Server:	My Support

Matthew_Pinkney

Hello,

There is no need to do a members call or nodes call.

You can use api/v2/volumes/<type> where type=142 for personal workspace. This will return you everything so you will likley want to limit it. If you need information about the node and the permissions on it you would do
api/v2/volumes/142?fields=properties&fields=permissions . No need for multiple calls.
In your screen shots you've got fields=data , data isn't a fieldgroup to filter with so won't do anything and may cause issues.
If you remove the ?fields=data from your last call of /api/v2/nodes/924654/permissions and it still doesn't work, you may need to confirm the version you are on supports that call.

Keith_Young

Quoted Alex Kropp on 04/04/2019 02:24 PM:

Out of curiosity, what’s your full CS version? Could be an update level thing I suppose. You can find it by going to any page on your instance > ? menu > About Content Server.

I’m not entirely sure when the permissions stuff was added to the API. If you use v1 instead of v2 with members does that work? There’s no v1 for the permissions endpoint.

The version of CS we have is 16.2.2

/api/v1/members works:

/api/v1/members/<ID> works:

/api/v2/members works:

/api/v2/members/<ID> does not work:

Cheers,

Keith.

Keith_Young

Hi,

Thanks for the advice. Removing the dields=data has no effect... "The REST API Url could not be found in the mappings registry"... so it might be part of a version issue, but I find it strange that only part of a new "v2" API would be implemented. I would tend to expect an all or nothing for a new version of an API...

I will try the volume query as well in a few minutes.

Again, thanks!

Cheers,

Keith.

Ferdinand Prantl

If you use an older version of CS, where "{cgi-url}/api/v2/volumes/142" was not available, you can try "{cgi-url}/api/v1/volumes/142".