Qodex.ai
Qodex.ai
Introduction
IMaaS Capture Services
session-tables
Returns a list of available tables for the given environment.Returns the table identified by tableId for the given environment.
session-doctypes
Returns the list of available Document Types for the given environment.Returns the Document Type identified by docType for the given environment.
session-files-{file Id}
Retrieves the file identified by the fileId.Appends or retries a stage file chunk.Deletes a stage file.
session-files
Creates a stage file.Deletes all stage files.
session-services
Retrieves a list of the Real-Time Services that are available.Convert Images Service.Process Image Service.Full Page OCR Service.Read BarCodes ServiceClassify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service
session
Retrieves the Session resource.Deletes your session data.Creates and exports a batch.
The Home Document is an entry point to the Core Capture Services.Provides product version information.
IMaaS Content Metadata Service
categories-{id}
get category by idupdate category detailspatch category details
categories
List all the categoriesCreate a new categoryget category by name
groups-{group Id}-members-{group Member Id}
Get group member detailsdelete group members
groups-{group Id}-members
Get group members detailsUpdate group membership detailsAdd a new group memberDelete Group Member
groups-{group Id}
Get group detailsDelete group
groups
List all groupsCreate a new group
instances-{category}/{type}-{id}-linked-parents-{folder Id}
Get linked parent detailsDelete linked parent
instances-{category}/{type}-{id}-linked-parents
List linked parentsAdd linked parent to an object
instances-{category}/{type}-{id}-acl
get ACL associated with object instanceChange ACL actionUpdate permits for an ACL associated with an object
instances-{category}/{type}-{id}-parent
Get parent instance detailsChange parent for object instance
instances-{category}/{type}-{id}-policies-{Retention Id}
Get a policy of an objectUpdate qualification date, base_date or policy replacement of an item policyDelete policy for an object
instances-{category}/{type}-{id}-policies
List all policies of an objectAttach a policy to an object
instances-{category}/{type}-{id}-holds
List all holds of an objectAttach a hold to an object
instances-{category}/{type}-{id}-hold/{Retention Id}
Get a hold of an objectReplace existing hold to be a new holdDelete hold for an object
instances-{category}/{type}-{id}-case-node/{case Node Id}
Get case instance detailsCreate case instance childList case role groups
instances-{category}/{type}-{id}
get object instance detailsupdate instance detailsdelete object instanceupdate instance detailsCopy an object instanceGet effective permissions of the objectRequest instance to send to searchGet history of changes on an object instance.Get relations based on source relation typeGet relations based on target relation type
instances-{category}/{type}
List object instancescreate new instance
instances-file/{type}/{id}-lock
Lock the file instanceDelete the lock on a file
instances-file/{type}/{id}-contents-{rendition Id}
get rendition detail of the fileUpdate a renditionDelete renditionPatch rendition
instances-file/{type}/{id}-contents
List all renditions associated with a fileAdd new rendition to file
instances-file/{type}/{id}
Delete all versions of an objectCheck if user privilege to download the content associated with file typeMake current to latest versionList all versions of the fileCheck in as next versionCheck in as current version
instances-case/{type}
Create case instanceGet case node instances
instances-folder/{type}/{id}/items
List object instances under the folder.create object instances under the folder.
localizations-{id}
get localization detailsupdate Localization detailsDelete Localization
localizations
List all Localizationsupdate all localizationsCreate a new LocalizationDelete all localizations
bundles-{id}
Get bundleDelete bundle
bundles-{bundle Id}/deployments
Get all bundlesInstall bundle into tenantDelete bundle deployment
bundles
Get all bundlesCreate bundle using zip file or json
permissions-{id}
get permission detailsupdate permission detailsDelete permissionpatch permission details
permissions
List all the permissionsCreate a new permission
retention-item Policy
For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filtersFor backward compatibility, it is old API for setting all item objects for null qualification date on given policy id
retention
List all CMS objects with policies or holds based on the filtersSet all item objects for null qualification date on given policy idRemove same hold id for all CMS objectsDispose a list of CMS objects which is from RPS approval listFor backward compatibility, it is old API for disposing a list of CMS objects which is from RPS approval list
case-type-definitions-{id}
Get case model by case model idUpdate case model by case model idDelete case model by case model id
case-type-definitions
List case modelsCreate a new case model
case-case-nodes/{id}
Get case node details by case node idUpdate case node by idDelete case node by idGet case node parent details
trait-definitions-{trait Name}-attributes-{attribute Id}
Get trait attribute detailsUpdate trait attribute detailsDelete trait attribute
trait-definitions-{trait Name}-attributes
List all the attributes associated with a traitcreate new trait attribute
trait-definitions-{trait Name}-index-definitions-{index Id}
Get trait index definition detailsUpdate trait index definition detailsDelete index definition details
trait-definitions-{trait Name}-index-definitions
List all the index definitions associated with a traitcreate new index definition for trait
trait-definitions-{trait Name}
get trait definition detailsupdate trait definitiondelete trait definitionpatch trait definition
trait-definitions
List all trait definitionscreate a new custom trait definition
type-definitions-{type Name}-attributes-{attribute Id}
Get type attribute detailsUpdate type attribute details
type-definitions-{type Name}-attributes
List all the attributes associated with a typecreate new type attribute
type-definitions-{type Name}-index-definitions-{index Id}
Get type index definition detailsUpdate type index definition detailsDelete index definition details
type-definitions-{type Name}-index-definitions
List all the index definitions associated with a typecreate new type index definition
type-definitions-{type Name}-required-traits
List all the required traits associated with the type definitionsassociate a new required trait with a type definition
type-definitions-{type Name}-requird-traits/{required Trait Id}
Get required trait detailsUpdate required trait detailsDelete the required trait definition
type-definitions-{type Name}
get type definition detailsupdate type definitionGet type and inherited types attributes details
type-definitions
List all type definitionscreate a new custom type definition for the given category.
namespaces-{namespace Id}
get Namespace DetailsUpdate a namespaceUpdate a namespace by patch
namespaces
Get list of Namespacescreate a new Namespace
List all service endpointsExecute full text search against search service
IMaaS Content Storage Service
v2-tenant/{tenant Id}
Upload content for a tenantGet total storage used for a tenant
v2-content-{id}-public Share Url-{url Id}
Delete a sharable linkUpdate a sharable linkRetrieve sharable link object
v2-content-{id}-public Share Url
Create a new sharable-link for download
v2-content-{id}
Get details of a specific contentDownload content
v2-content
Tenant user upload content
v2
Upload content with upload URL
Get all services of Content Storage Service
IMaaS Contract sample app - contract approval use case
misc
get-namespacesget-all-cms-contract-file-typeget-cms-contract-file-typedelete-cms-contract-file-typeget-all-attributes-from-cms-contract-file-typeget-attribute-from-cms-contract-file-typeadd-attribute-to-cms-contract-file-typeget-all-workflow-modelsdelete-workflow-modeldelete-all-cms-contract-filesget-cms-contract-filedelete-cms-contract-fileprocess-document-with-riskguard
get-access-tokencreate-namespacecreate-cms-contract-file-typecreate-workflow-model-for-contract-approval
IMaaS Riskguard service
risk-guard-otds-correctriskguard-ot2-healthriskguard-ot2-versiontestriskguard-ot2-process
IMaaS Viewer Service
viewers
Return all available viewersLoads the named `viewer`
Return the service rootReturn the service version informationReturn the service health check
IMaaS Workflow services
Workflow action and model services-tasks-{task Id}-assignments
Delete assignments on a taskGet an assignments for a taskCreate an assignment on a taskUpdate an assignment on a task
Workflow action and model services-tasks-{task Id}-attachments-{attachment Id}
Delete an attachment on a taskGet an attachment on a task
Workflow action and model services-tasks-{task Id}-attachments
List attachments on a taskCreate a new attachment on a task.
Workflow action and model services-tasks-{task Id}-comments-{comment Id}
Delete a comment on a taskGet a comment on a task
Workflow action and model services-tasks-{task Id}-comments
Get comments on a taskCreate a new comment on a task
Workflow action and model services-tasks-{task Id}-variables-{variable Name}
Delete a variable on a taskGet a variable for a taskUpdate a single variable on a task
Workflow action and model services-tasks-{task Id}-variables
List variables for a taskCreate variables on a task
Workflow action and model services-tasks-{task Id}
Get a taskAct on a taskUpdate a task
Workflow action and model services-tasks
Get tasksCreate a sub task
Workflow action and model services-runtime/models
Get executable process modelsCreate a new executable process modelRetrieve executable process model contentDelete an executable process model
Workflow action and model services-models
Convert process model content from json to xml or vice versaValidate process model content
Workflow action and model services-administration/privileges-{privilege Name}-groups
Delete a specific privilege for group(s)Add a specific privilege for group(s)
Workflow action and model services-administration/privileges-{privilege Name}-roles
Delete a specific privilege for role(s)Add a specific privilege for role(s)
Workflow action and model services-administration/privileges-{privilege Name}-users
Delete a specific privilege for user(s)Add a specific privilege for user(s)
Workflow action and model services-administration/privileges
List privileges
Workflow action and model services-designtime/models-{model Id}
Delete a non-executable process modelRetrieve process model content
Workflow action and model services-designtime/models
Get non-executable process modelsCreate a non-executable process model
Workflow action and model services-process-instances-adhoc-subprocesses/{adhoc Subprocess Id}-activities
List of enabled activities for adhoc sub processExecute activities in adhoc sub process
Workflow action and model services-process-instances-adhoc-subprocesses/{adhoc Subprocess Id}
Complete adhoc sub process
Workflow action and model services-process-instances-administration/failedasync-jobs
List failed async jobsRecover failed async job
Workflow action and model services-process-instances-executions
List of executions for a process instanceList of executions for a process instance.Broadcast signal or message to a process instance
Workflow action and model services-process-instances-{process Instance Id}-comments-{comment Id}
Delete a comment on a process instanceGet a comment on a process instance
Workflow action and model services-process-instances-{process Instance Id}-comments
Get comments on a process instanceCreate new comment on a process instance
Workflow action and model services-process-instances-{process Instance Id}-variables-{variable Name}
Delete a variable on a process instanceGet a variable for a process instanceUpdate a single variable on a process instance
Workflow action and model services-process-instances-{process Instance Id}-variables
List variables for a process instanceCreate variables on a process instance
Workflow action and model services-process-instances-{process Instance Id}
Delete a process instanceGet a process instanceActivate or suspend a process instanceList of adhoc sub processes for a process instanceGet diagram for a process instanceInject activity in a process instance
Workflow action and model services-process-instances
List process instancesCreate a process instanceBroadcast signal to create process instances
Workflow action and model services
Get workflow version information
Workflow jobs service-{job Id}
Get a single external worker jobComplete an external worker jobComplete an external worker job with an errorFail an external worker job
Workflow jobs service
List external worker jobsAcquire external worker jobs
Workflow History Service-historic-task-instances
List historic task instancesGet a historic task instance
Workflow History Service-historic-process-instances
List historic process instancesGet a historic process instance
Workflow History Service
List process task instances audit logList process activity instances audit logList historic activity instancesList process instances audit logGet workflow version information
OpenText Developer Administration API
authenticators-{authenticator Id}
Get organization authenticatorUpdate organization authenticatorDelete organization authenticator
authenticators
Create organization authenticator
organizations/{organization Id}-tenants-{tenant Id}-users-{user Id}
Get userUpdate userDelete user
organizations/{organization Id}-tenants-{tenant Id}-users
Get all usersCreate user
organizations/{organization Id}-tenants-{tenant Id}-authenticators-{authenticator Id}
Get tenant authenticatorUpdate tenant authenticatorDelete tenant authenticator
organizations/{organization Id}-tenants-{tenant Id}-authenticators
Create tenant authenticator
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}-users-{user Id}
Subscribe userUnsubscribe user
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}-users
Get all users subscribed to an app
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}
Add appRemove app
organizations/{organization Id}-tenants-{tenant Id}
Get tenantUpdate tenantDelete tenant
organizations/{organization Id}-tenants
Get tenantsCreate tenant
organizations/{organization Id}-apps-{app Id}
Get appUpdate appDelete appUpdate service clientGet tenants by appId
organizations/{organization Id}-apps
Get appsCreate app
organizations/{organization Id}-clients
Get service clientsUpdate service client
Opentext Core Content Workspace API
Preparation
OAuthCurrent subscriptionSubscription usersSubscription user aliasesSubscription RootSubscription Root ChildrenCreate FolderCreate trait
Workspace types-Create and updated workspace type
Create workspace typeUpdate roles
Workspace types-Create and update localized workspace type
Create workspace type (localized)Update attribute localizationUpdate workspace type locations
Workspace types-Read workspace type(s)
Get workspace typesGet workspace type
Workspace types-Update attributes and permission templates
Create workspace type EmployeeAttrUpdate attributesUpdate permission templatesDelete Workspace Type EmployeeAttr
Workspace types-Picklist
Create workspace type EmployeePickDelete PicklistDelete Workspace Type EmployeePick
Workspace templates
Create workspace template (minimum)Create workspace template (maximum)Update folder structureUpdate display nameGet workspace templateGet workspace templates
Workspace instances-Create Instance
Create instance with propertiesCreate instance with trait
Workspace instances-Read and modify roles
List roles of Kristen instanceAdd user to roleList members of roleRemove user from role
Workspace instances-Update instance
Update instanceUpdate instance attributes
Workspace instances-Read and modify permissions
Get Kristen instance ACLGrant and revokeReplace ACL
Workspace instances-Retrieve instances (localized)
Get instances (prefer French)
Workspace instances-Location for workspace type (localized)
Get which workspace types for folder (French)
Delete/cleanup
Delete Kate instanceDelete Kristen instanceDelete workspace template (minimum)Delete workspace template (maximum)Delete workspace type EmployeeDelete workspace type (localized)Delete traitDelete folderDummy to cleanup remaining Qodex variables
Opentext Core Content business object API
OAuthCreate/Update BOConfigGet BOConfigsGet BOConfigDelete BOConfigCreate/Update WorkspacesGet Workspaces
Introduction
IMaaS Capture Services
session-tables
Returns a list of available tables for the given environment.Returns the table identified by tableId for the given environment.
session-doctypes
Returns the list of available Document Types for the given environment.Returns the Document Type identified by docType for the given environment.
session-files-{file Id}
Retrieves the file identified by the fileId.Appends or retries a stage file chunk.Deletes a stage file.
session-files
Creates a stage file.Deletes all stage files.
session-services
Retrieves a list of the Real-Time Services that are available.Convert Images Service.Process Image Service.Full Page OCR Service.Read BarCodes ServiceClassify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service
session
Retrieves the Session resource.Deletes your session data.Creates and exports a batch.
The Home Document is an entry point to the Core Capture Services.Provides product version information.
IMaaS Content Metadata Service
categories-{id}
get category by idupdate category detailspatch category details
categories
List all the categoriesCreate a new categoryget category by name
groups-{group Id}-members-{group Member Id}
Get group member detailsdelete group members
groups-{group Id}-members
Get group members detailsUpdate group membership detailsAdd a new group memberDelete Group Member
groups-{group Id}
Get group detailsDelete group
groups
List all groupsCreate a new group
instances-{category}/{type}-{id}-linked-parents-{folder Id}
Get linked parent detailsDelete linked parent
instances-{category}/{type}-{id}-linked-parents
List linked parentsAdd linked parent to an object
instances-{category}/{type}-{id}-acl
get ACL associated with object instanceChange ACL actionUpdate permits for an ACL associated with an object
instances-{category}/{type}-{id}-parent
Get parent instance detailsChange parent for object instance
instances-{category}/{type}-{id}-policies-{Retention Id}
Get a policy of an objectUpdate qualification date, base_date or policy replacement of an item policyDelete policy for an object
instances-{category}/{type}-{id}-policies
List all policies of an objectAttach a policy to an object
instances-{category}/{type}-{id}-holds
List all holds of an objectAttach a hold to an object
instances-{category}/{type}-{id}-hold/{Retention Id}
Get a hold of an objectReplace existing hold to be a new holdDelete hold for an object
instances-{category}/{type}-{id}-case-node/{case Node Id}
Get case instance detailsCreate case instance childList case role groups
instances-{category}/{type}-{id}
get object instance detailsupdate instance detailsdelete object instanceupdate instance detailsCopy an object instanceGet effective permissions of the objectRequest instance to send to searchGet history of changes on an object instance.Get relations based on source relation typeGet relations based on target relation type
instances-{category}/{type}
List object instancescreate new instance
instances-file/{type}/{id}-lock
Lock the file instanceDelete the lock on a file
instances-file/{type}/{id}-contents-{rendition Id}
get rendition detail of the fileUpdate a renditionDelete renditionPatch rendition
instances-file/{type}/{id}-contents
List all renditions associated with a fileAdd new rendition to file
instances-file/{type}/{id}
Delete all versions of an objectCheck if user privilege to download the content associated with file typeMake current to latest versionList all versions of the fileCheck in as next versionCheck in as current version
instances-case/{type}
Create case instanceGet case node instances
instances-folder/{type}/{id}/items
List object instances under the folder.create object instances under the folder.
localizations-{id}
get localization detailsupdate Localization detailsDelete Localization
localizations
List all Localizationsupdate all localizationsCreate a new LocalizationDelete all localizations
bundles-{id}
Get bundleDelete bundle
bundles-{bundle Id}/deployments
Get all bundlesInstall bundle into tenantDelete bundle deployment
bundles
Get all bundlesCreate bundle using zip file or json
permissions-{id}
get permission detailsupdate permission detailsDelete permissionpatch permission details
permissions
List all the permissionsCreate a new permission
retention-item Policy
For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filtersFor backward compatibility, it is old API for setting all item objects for null qualification date on given policy id
retention
List all CMS objects with policies or holds based on the filtersSet all item objects for null qualification date on given policy idRemove same hold id for all CMS objectsDispose a list of CMS objects which is from RPS approval listFor backward compatibility, it is old API for disposing a list of CMS objects which is from RPS approval list
case-type-definitions-{id}
Get case model by case model idUpdate case model by case model idDelete case model by case model id
case-type-definitions
List case modelsCreate a new case model
case-case-nodes/{id}
Get case node details by case node idUpdate case node by idDelete case node by idGet case node parent details
trait-definitions-{trait Name}-attributes-{attribute Id}
Get trait attribute detailsUpdate trait attribute detailsDelete trait attribute
trait-definitions-{trait Name}-attributes
List all the attributes associated with a traitcreate new trait attribute
trait-definitions-{trait Name}-index-definitions-{index Id}
Get trait index definition detailsUpdate trait index definition detailsDelete index definition details
trait-definitions-{trait Name}-index-definitions
List all the index definitions associated with a traitcreate new index definition for trait
trait-definitions-{trait Name}
get trait definition detailsupdate trait definitiondelete trait definitionpatch trait definition
trait-definitions
List all trait definitionscreate a new custom trait definition
type-definitions-{type Name}-attributes-{attribute Id}
Get type attribute detailsUpdate type attribute details
type-definitions-{type Name}-attributes
List all the attributes associated with a typecreate new type attribute
type-definitions-{type Name}-index-definitions-{index Id}
Get type index definition detailsUpdate type index definition detailsDelete index definition details
type-definitions-{type Name}-index-definitions
List all the index definitions associated with a typecreate new type index definition
type-definitions-{type Name}-required-traits
List all the required traits associated with the type definitionsassociate a new required trait with a type definition
type-definitions-{type Name}-requird-traits/{required Trait Id}
Get required trait detailsUpdate required trait detailsDelete the required trait definition
type-definitions-{type Name}
get type definition detailsupdate type definitionGet type and inherited types attributes details
type-definitions
List all type definitionscreate a new custom type definition for the given category.
namespaces-{namespace Id}
get Namespace DetailsUpdate a namespaceUpdate a namespace by patch
namespaces
Get list of Namespacescreate a new Namespace
List all service endpointsExecute full text search against search service
IMaaS Content Storage Service
v2-tenant/{tenant Id}
Upload content for a tenantGet total storage used for a tenant
v2-content-{id}-public Share Url-{url Id}
Delete a sharable linkUpdate a sharable linkRetrieve sharable link object
v2-content-{id}-public Share Url
Create a new sharable-link for download
v2-content-{id}
Get details of a specific contentDownload content
v2-content
Tenant user upload content
v2
Upload content with upload URL
Get all services of Content Storage Service
IMaaS Contract sample app - contract approval use case
misc
get-namespacesget-all-cms-contract-file-typeget-cms-contract-file-typedelete-cms-contract-file-typeget-all-attributes-from-cms-contract-file-typeget-attribute-from-cms-contract-file-typeadd-attribute-to-cms-contract-file-typeget-all-workflow-modelsdelete-workflow-modeldelete-all-cms-contract-filesget-cms-contract-filedelete-cms-contract-fileprocess-document-with-riskguard
get-access-tokencreate-namespacecreate-cms-contract-file-typecreate-workflow-model-for-contract-approval
IMaaS Riskguard service
risk-guard-otds-correctriskguard-ot2-healthriskguard-ot2-versiontestriskguard-ot2-process
IMaaS Viewer Service
viewers
Return all available viewersLoads the named `viewer`
Return the service rootReturn the service version informationReturn the service health check
IMaaS Workflow services
Workflow action and model services-tasks-{task Id}-assignments
Delete assignments on a taskGet an assignments for a taskCreate an assignment on a taskUpdate an assignment on a task
Workflow action and model services-tasks-{task Id}-attachments-{attachment Id}
Delete an attachment on a taskGet an attachment on a task
Workflow action and model services-tasks-{task Id}-attachments
List attachments on a taskCreate a new attachment on a task.
Workflow action and model services-tasks-{task Id}-comments-{comment Id}
Delete a comment on a taskGet a comment on a task
Workflow action and model services-tasks-{task Id}-comments
Get comments on a taskCreate a new comment on a task
Workflow action and model services-tasks-{task Id}-variables-{variable Name}
Delete a variable on a taskGet a variable for a taskUpdate a single variable on a task
Workflow action and model services-tasks-{task Id}-variables
List variables for a taskCreate variables on a task
Workflow action and model services-tasks-{task Id}
Get a taskAct on a taskUpdate a task
Workflow action and model services-tasks
Get tasksCreate a sub task
Workflow action and model services-runtime/models
Get executable process modelsCreate a new executable process modelRetrieve executable process model contentDelete an executable process model
Workflow action and model services-models
Convert process model content from json to xml or vice versaValidate process model content
Workflow action and model services-administration/privileges-{privilege Name}-groups
Delete a specific privilege for group(s)Add a specific privilege for group(s)
Workflow action and model services-administration/privileges-{privilege Name}-roles
Delete a specific privilege for role(s)Add a specific privilege for role(s)
Workflow action and model services-administration/privileges-{privilege Name}-users
Delete a specific privilege for user(s)Add a specific privilege for user(s)
Workflow action and model services-administration/privileges
List privileges
Workflow action and model services-designtime/models-{model Id}
Delete a non-executable process modelRetrieve process model content
Workflow action and model services-designtime/models
Get non-executable process modelsCreate a non-executable process model
Workflow action and model services-process-instances-adhoc-subprocesses/{adhoc Subprocess Id}-activities
List of enabled activities for adhoc sub processExecute activities in adhoc sub process
Workflow action and model services-process-instances-adhoc-subprocesses/{adhoc Subprocess Id}
Complete adhoc sub process
Workflow action and model services-process-instances-administration/failedasync-jobs
List failed async jobsRecover failed async job
Workflow action and model services-process-instances-executions
List of executions for a process instanceList of executions for a process instance.Broadcast signal or message to a process instance
Workflow action and model services-process-instances-{process Instance Id}-comments-{comment Id}
Delete a comment on a process instanceGet a comment on a process instance
Workflow action and model services-process-instances-{process Instance Id}-comments
Get comments on a process instanceCreate new comment on a process instance
Workflow action and model services-process-instances-{process Instance Id}-variables-{variable Name}
Delete a variable on a process instanceGet a variable for a process instanceUpdate a single variable on a process instance
Workflow action and model services-process-instances-{process Instance Id}-variables
List variables for a process instanceCreate variables on a process instance
Workflow action and model services-process-instances-{process Instance Id}
Delete a process instanceGet a process instanceActivate or suspend a process instanceList of adhoc sub processes for a process instanceGet diagram for a process instanceInject activity in a process instance
Workflow action and model services-process-instances
List process instancesCreate a process instanceBroadcast signal to create process instances
Workflow action and model services
Get workflow version information
Workflow jobs service-{job Id}
Get a single external worker jobComplete an external worker jobComplete an external worker job with an errorFail an external worker job
Workflow jobs service
List external worker jobsAcquire external worker jobs
Workflow History Service-historic-task-instances
List historic task instancesGet a historic task instance
Workflow History Service-historic-process-instances
List historic process instancesGet a historic process instance
Workflow History Service
List process task instances audit logList process activity instances audit logList historic activity instancesList process instances audit logGet workflow version information
OpenText Developer Administration API
authenticators-{authenticator Id}
Get organization authenticatorUpdate organization authenticatorDelete organization authenticator
authenticators
Create organization authenticator
organizations/{organization Id}-tenants-{tenant Id}-users-{user Id}
Get userUpdate userDelete user
organizations/{organization Id}-tenants-{tenant Id}-users
Get all usersCreate user
organizations/{organization Id}-tenants-{tenant Id}-authenticators-{authenticator Id}
Get tenant authenticatorUpdate tenant authenticatorDelete tenant authenticator
organizations/{organization Id}-tenants-{tenant Id}-authenticators
Create tenant authenticator
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}-users-{user Id}
Subscribe userUnsubscribe user
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}-users
Get all users subscribed to an app
organizations/{organization Id}-tenants-{tenant Id}-apps/{app Id}
Add appRemove app
organizations/{organization Id}-tenants-{tenant Id}
Get tenantUpdate tenantDelete tenant
organizations/{organization Id}-tenants
Get tenantsCreate tenant
organizations/{organization Id}-apps-{app Id}
Get appUpdate appDelete appUpdate service clientGet tenants by appId
organizations/{organization Id}-apps
Get appsCreate app
organizations/{organization Id}-clients
Get service clientsUpdate service client
Opentext Core Content Workspace API
Preparation
OAuthCurrent subscriptionSubscription usersSubscription user aliasesSubscription RootSubscription Root ChildrenCreate FolderCreate trait
Workspace types-Create and updated workspace type
Create workspace typeUpdate roles
Workspace types-Create and update localized workspace type
Create workspace type (localized)Update attribute localizationUpdate workspace type locations
Workspace types-Read workspace type(s)
Get workspace typesGet workspace type
Workspace types-Update attributes and permission templates
Create workspace type EmployeeAttrUpdate attributesUpdate permission templatesDelete Workspace Type EmployeeAttr
Workspace types-Picklist
Create workspace type EmployeePickDelete PicklistDelete Workspace Type EmployeePick
Workspace templates
Create workspace template (minimum)Create workspace template (maximum)Update folder structureUpdate display nameGet workspace templateGet workspace templates
Workspace instances-Create Instance
Create instance with propertiesCreate instance with trait
Workspace instances-Read and modify roles
List roles of Kristen instanceAdd user to roleList members of roleRemove user from role
Workspace instances-Update instance
Update instanceUpdate instance attributes
Workspace instances-Read and modify permissions
Get Kristen instance ACLGrant and revokeReplace ACL
Workspace instances-Retrieve instances (localized)
Get instances (prefer French)
Workspace instances-Location for workspace type (localized)
Get which workspace types for folder (French)
Delete/cleanup
Delete Kate instanceDelete Kristen instanceDelete workspace template (minimum)Delete workspace template (maximum)Delete workspace type EmployeeDelete workspace type (localized)Delete traitDelete folderDummy to cleanup remaining Qodex variables
Opentext Core Content business object API
OAuthCreate/Update BOConfigGet BOConfigsGet BOConfigDelete BOConfigCreate/Update WorkspacesGet Workspaces
HomeIMaaS Content Metadata Servicetype-definitions-{type Name}-attributes-{attribute Id}

type-definitions-{type Name}-attributes-{attribute Id}

Number of APIs: 2

  1. Get type attribute details GET {{baseUrl}}/type-definitions/:typeName/attributes/:attributeId

  2. Update type attribute details PUT {{baseUrl}}/type-definitions/:typeName/attributes/:attributeId

Previous
create a new custom trait definition
Next
Get type attribute details