Opentext Core Content Workspace API

Number of APIs: 50

Workspace API examples usage

This collection uses collection variables (see tab Variables). There are already some defined but with empty values. These variables depend on your environment and must be entered/adapted before executing the examples. You can create in the Developer Console an App for your tenant. If you extend the Core Content App there are two sets of OAuth clients created, called Public Client Keys and Confidential Client Keys. For this collection you need the later, Confidential Client Keys to set the value for clientid and clientsecret

Variable	Description
appconfclientid	Client Id of your Confidential Client Keys
appconfclientsecret	Client Secret of your Confidential Client Keys
tenantsvcaccuid	Tenant service account user (usually mail address)
tenantsvcaccpwd	Corresponding password to tenantsvcaccuid
tenant-id	Id of your tenant

You usually don't need to adapt the following variables.

Variable	Description
subscriptionnamespaceprefix	Prefix of the subscription namespace*
subscriptionnamespacename	Name of the subscription namespace*
api_host	Central host to access OT2 APIs**
token-endpoint	URL of the OAuth2 authentication service**
cms-service-endpoint	URL of the Content Metadata service**
workspace-service-endpoint	URL of the Workspace service**
access_token	OAuth Access Token***

* Leave it, as it is. The right value is automatically detected by request Preparation/Current subscription.

** Usually you can leave the default value

*** Is retrieved via request Preparation/OAuth

The whole collections is build with the principle that the requests are executed in order. Some can be executed independently (except authentication) others depend on one or more previous requests. These previous requests retrieve information from the response and store it in collection variables. These variables are referenced by subsequent requests i.e. their name enclosed by double curly brackets e.g. {{folder_id}}.

All requests in the Preparation folder are used to retrieve or create data needed by the subsequent requests, especially the authentication token. These calls do not use Workspace API but CMS resp. OTDS API calls.

The last folder is the counterpart to it. It contains methods to remove the created data and also to delete the related collection variables. In contraction to Preparation folder there are Workspace API request to delete workspace types and templates. The last call in the folder cleans up the remaining collection variables. So all temporary variables are removed and only the variables in the above table remain.

1. Preparation - Subscription users

GET {{cms-service-endpoint}}/subscription-users

---

2. Preparation - Subscription Root Children

GET {{cms-service-endpoint}}/instances/folder/cms_folder/{{subscription-root-id}}/items?sortby=name asc

---

3. Preparation - Create trait

POST {{cms-service-endpoint}}/trait-definitions

---

4. Workspace types-Create and updated workspace type - Create workspace type

POST {{workspace-service-endpoint}}/api/v1/workspace/types

---

5. Workspace types-Create and update localized workspace type - Create workspace type (localized)

POST {{workspace-service-endpoint}}/api/v1/workspace/types

---

6. Workspace types-Update attributes and permission templates - Update attributes

PUT {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_attr}}

---

7. Workspace templates - Create workspace template (minimum)

POST