Skip to main content
Skip table of contents



OpenText can help you tackle the most complex digital transformation programs with confidence. With the world’s most complete and integrated Information Management platform, OpenText empowers customers to organize, integrate and protect data and content as it flows through business processes inside and outside an organization.

OpenText Content Metadata Service API (CMS) handles object metadata and is tenant-based. A Service/User Token is required for accessing these APIs. Objects can be documents, files, folders, business objects, relationships, and permissions. Namespaces, Categories, Types, and Traits are used for domain-specific business logic. Content uploads and downloads can be done by these APIs as well. Validations and Localizations can be customized. Retention, History, Search, Filtering, and Scripts are supported. Deployment bundling, upgrade, case modeling, and templates are available. A default namespace is provided. System categories are cms_file, cms_folder, and cms_object. Users can create customized categories, type definitions, and trait definitions based on their business needs. Object instances are created based on category, type, and trait. The type can be extendable based on business needs.

You can find more details and the supported operations at OpenText | qibb Catalog.

How to get started with OpenText integration

Before you get started with OpenText integration, please make sure that you have the needed permissions for the operations.

To get started, you will need your Tenant ID, Username, Password, Client ID, and Client Secret information for authentication. If you do not already have these credentials, you can create them by following these steps:

  1. Sign in to OpenText and open the OpenText Admin Center of your organization.

  2. To find the Tenant ID, you need to navigate to Tenants from the side menu. If a tenant doesn’t exist you can create a new one by clicking on the New tenant button and following the procedure to create a new tenant.
    If you already have created a new Tenant and you want to use it, proceed by clicking on the name of the chosen tenant.

  3. The Tenant ID is under the Tenant ID section of the Tenant Overview page.

  4. To create a new App (to be able to use Client ID, and Client Secret) you need to navigate back to the OpenText Admin Center of your organization. From there, navigate to the Apps section.

  5. From the side panel choose Create a new standalone app and select Next.

  6. Fill in all mandatory fields and select Save.

  7. After the successful creation of the App, you will receive overview information for your App details and client credentials. You can copy all credentials by selecting the Copy all button and save them for later use.
    You can find the Client ID stored as confidential_client inside the credentials you have saved, and the Client Secret under confidential_client_secret.

  8. Your Username is the e-mail address used to register your account, and your Password is the IMaaS (or Management Services) Password you received while creating your Organization.

Now you have all the credentials you need to proceed — Tenant ID, Username, Password, Client ID, and Client Secret.

  1. Go to qibb Workflow Editor, open Node Catalog in the right sidebar, and install the OpenText node by clicking on the + button.

  2. Drag the OpenText Auth, any needed OpenText API node, and any other nodes you require from the left sidebar to your flow and connect them.

  3. Open the OpenText Auth node. Enter your credentials into the respective fields.
    The Host URL is preset for the OpenText Dev Server. If you want to change it you can overwrite it.

  4. Open the OpenText API node you need to use, select an operation and you can start using the integration!

Importing flow examples of a node

Once you've successfully installed a node from the qibb catalog, you can easily import example flows that showcase how the nodes can be used. These example flows are directly accessible within the Flow Editor and are designed to guide users with helpful hints, including how to configure mandatory parameters and credentials.

Here's how to import examples:

  1. In the top right corner of the Flow Editor, click on the menu icon.

  2. Select Import to open the Import Dialog.

  3. Click on the Examples tab.

  4. Choose an example from the list.

  5. Confirm your selection by clicking on the Import button.

By following these steps, you are now ready to make basic API calls using the provided examples. For further exploration of what’s possible, you can find more complex examples in the Flow Catalog.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.