Opentext Core Content Workspace API
Number of APIs: 50
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 You usually don't need to adapt the following variables. * 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.Workspace API examples usage
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
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***
1. Preparation - OAuth
POST {{token-endpoint}}/oauth2/token
2. Preparation - Current subscription
GET {{cms-service-endpoint}}/subscriptions/current-subscription
3. Preparation - Subscription users
GET {{cms-service-endpoint}}/subscription-users
4. Preparation - Subscription user aliases
GET {{cms-service-endpoint}}/user-aliases
5. Preparation - Subscription Root
GET {{cms-service-endpoint}}/instances/folder/cms_folder/subscription-root
6. Preparation - Subscription Root Children
GET {{cms-service-endpoint}}/instances/folder/cms_folder/{{subscription-root-id}}/items?sortby=name asc
7. Preparation - Create Folder
POST {{cms-service-endpoint}}/instances/folder/ccmapp_enterprise_volume/{{enterprise_volume.id}}/items
8. Preparation - Create trait
POST {{cms-service-endpoint}}/trait-definitions
9. Workspace types-Create and updated workspace type - Create workspace type
POST {{workspace-service-endpoint}}/api/v1/workspace/types
10. Workspace types-Create and updated workspace type - Update roles
PATCH {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}
11. Workspace types-Create and update localized workspace type - Create workspace type (localized)
POST {{workspace-service-endpoint}}/api/v1/workspace/types
12. Workspace types-Create and update localized workspace type - Update attribute localization
PUT {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}
13. Workspace types-Create and update localized workspace type - Update workspace type locations
PATCH {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}
14. Workspace types-Read workspace type(s) - Get workspace types
GET {{workspace-service-endpoint}}/api/v1/workspace/types?expandAll=true&page=0&size=1000
15. Workspace types-Read workspace type(s) - Get workspace type
GET {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}
16. Workspace types-Update attributes and permission templates - Create workspace type EmployeeAttr
POST {{workspace-service-endpoint}}/api/v1/workspace/types
17. Workspace types-Update attributes and permission templates - Update attributes
PUT {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_attr}}
18. Workspace types-Update attributes and permission templates - Update permission templates
PATCH {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_attr}}
19. Workspace types-Update attributes and permission templates - Delete Workspace Type EmployeeAttr
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_attr}}
20. Workspace types-Picklist - Create workspace type EmployeePick
POST {{workspace-service-endpoint}}/api/v1/workspace/types
21. Workspace types-Picklist - Delete Picklist
PUT {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_pick}}
22. Workspace types-Picklist - Delete Workspace Type EmployeePick
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_pick}}
23. Workspace templates - Create workspace template (minimum)
POST {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}/templates
24. Workspace templates - Create workspace template (maximum)
POST {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/templates
25. Workspace templates - Update folder structure
PATCH {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}/templates/{{workspace_template_employee_na}}
26. Workspace templates - Update display name
PATCH {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/templates/{{workspace_template_employee_eu}}
27. Workspace templates - Get workspace template
GET {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/templates/{{workspace_template_employee_eu}}
28. Workspace templates - Get workspace templates
GET {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}/templates
29. Workspace instances-Create Instance - Create instance with properties
POST {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}/templates/{{workspace_template_employee_na}}/instances
30. Workspace instances-Create Instance - Create instance with trait
POST {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/templates/{{workspace_template_employee_eu}}/instances
31. Workspace instances-Read and modify roles - List roles of Kristen instance
GET {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}/roles
32. Workspace instances-Read and modify roles - Add user to role
POST {{workspace-service-endpoint}}/api/v1/workspace/instances/roles/{{role.employee.id}}/members
33. Workspace instances-Read and modify roles - List members of role
GET {{workspace-service-endpoint}}/api/v1/workspace/instances/roles/{{role.employee.id}}/members/{{member_id}}
34. Workspace instances-Read and modify roles - Remove user from role
DELETE {{workspace-service-endpoint}}/api/v1/workspace/instances/roles/{{role.employee.id}}/members/{{member_id}}
35. Workspace instances-Update instance - Update instance
PUT {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}
36. Workspace instances-Update instance - Update instance attributes
PATCH {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}
37. Workspace instances-Read and modify permissions - Get Kristen instance ACL
GET {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}/acl
38. Workspace instances-Read and modify permissions - Grant and revoke
PATCH {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}/acl
39. Workspace instances-Read and modify permissions - Replace ACL
PUT {{workspace-service-endpoint}}/api/v1/workspace/instances/{{kristen_instance.root_folder.id}}/acl
40. Workspace instances-Retrieve instances (localized) - Get instances (prefer French)
GET {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/instances?include-types=true
41. Workspace instances-Location for workspace type (localized) - Get which workspace types for folder (French)
GET {{workspace-service-endpoint}}/api/v1/workspace/folders/{{employee_folder.id}}/locations
42. Delete/cleanup - Delete Kate instance
DELETE {{cms-service-endpoint}}/instances/case/{{case_model_employee_na}}/{{kate_instance.case_id}}?recursive=true
43. Delete/cleanup - Delete Kristen instance
DELETE {{cms-service-endpoint}}/instances/case/{{case_model_employee_eu}}/{{kristen_instance.case_id}}?recursive=true
44. Delete/cleanup - Delete workspace template (minimum)
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}/templates/{{workspace_template_employee_na}}
45. Delete/cleanup - Delete workspace template (maximum)
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}/templates/{{workspace_template_employee_eu}}
46. Delete/cleanup - Delete workspace type Employee
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee}}
47. Delete/cleanup - Delete workspace type (localized)
DELETE {{workspace-service-endpoint}}/api/v1/workspace/types/{{workspace_type_employee_l10n}}
48. Delete/cleanup - Delete trait
DELETE {{cms-service-endpoint}}/trait-definitions/{{subscription_namespace_prefix}}_responsible_person
49. Delete/cleanup - Delete folder
DELETE {{cms-service-endpoint}}/instances/folder/cms_folder/{{employee_folder.id}}
50. Delete/cleanup - Dummy to cleanup remaining Qodex variables
GET {{workspace-service-endpoint}}/api/v1/workspace/types?expandAll=true&page=0&size=1000
ENDPOINTS