Opentext Core Content business object API
Number of APIs: 7
The Core Content Business Object API (BO API) collection provides examples for using the Businesss Object Service (ccbo). This collection uses collection variables (see tab Variables). The collection consists of these requests (see each request's documentation and the swagger for more details):
- OAuth Create/Update BOConfig Get BOConfigs Get BOConfig Delete BOConfig Create/Update Workspaces Get WorkspacesOverview
Variable
Description
appconfclientid
Client Id of your Confidential Client Keys
appconfclientsecret
Client Secret of your Confidential Client Keys
tenantsvcaccuid
Tenant service account user (usually email address)
tenantsvcaccpwd
Corresponding password to tenantsvcaccuid
tenant_id
Id of your tenant
- Obtains a token to be used on the rest of the requests.
1. OAuth
POST {{token-endpoint}}/oauth2/token
This request obtains an access token to be used with all the other requests in this collection. It sets the collection variable access_token and depends on these collection variables: - tokenendpoint - tenantid - tenantsvcaccuid - tenantsvcaccpwd - appconfclientid - appconfclientsecret
2. Create/Update BOConfig
POST {{bo-service-endpoint}}/api/v1/admin/boconfigs
This request stores a Business Object Configuration into the Core Content system.
Before issuing this request, a workspace type must have been created and the system names of the workspace type, workspace type template, workspace type attributes, and workspace type roles identified for use in the BOConfig.
The name of the BOConfig is determined from the businessObjectConfigName and, if missing, defaults to the externalBusinessObjectType.
If a BOConfig of the same name exists, it is updated with this body.
3. Get BOConfigs
GET {{bo-service-endpoint}}/api/v1/admin/boconfigs
This request retrieves:
all the known BOConfigs
OR those matching the
filter
query parameter.
4. Get BOConfig
GET {{bo-service-endpoint}}/api/v1/admin/boconfigs/OvershoeBO
This request retrieves the specified BOConfig.
5. Delete BOConfig
DELETE {{bo-service-endpoint}}/api/v1/admin/boconfigs/OvershoeBO
This request deletes the specified BOConfig.
6. Create/Update Workspaces
PUT {{bo-service-endpoint}}/api/v1/businessworkspaces
This request creates or updates workspaces for the business objects identified in the request body.
Each workspace will have the properties, propertyGroups, relations, and roles populations specified for its business object.
7. Get Workspaces
POST {{bo-service-endpoint}}/api/v1/businessworkspaces/ids
This request retrieves the workspace ids for the specified business objects.
ENDPOINTS