Application programming interface

With the application programming interface, you can manage and query Maximo® Collaborate information and features. For example, users, usage information, documents, knowledge elements, diagnosis libraries, and experts.

To use an API, you need to generate an API key. For more information, see Managing API keys.

Maximo Collaborate APIs

To see the details of the following APIs, log in to Maximo Collaborate, and in the Tutorials section, click API documentation.

User management API: You can complete tasks such as managing user authorization, roles, and API keys.
Usage API: You can complete tasks such as getting document collection usage information, document usage information, and document search usage information.
Document Management API: You can complete tasks such as listing, creating, and deleting document collections and uploading and downloading documents.
Document Query: Document Query API v2: You can complete tasks such as listing all document collections, getting detailed information about search configuration, and searching documents in projects by using Watson Discovery v2 APIs.; Document Query API v1: You can complete tasks such as listing all document collections, getting detailed information about a collection. You can search documents in multiple collections by using Watson Discovery v1 APIs.; Note:
Starting in Maximo Application Suite 9.0, the document query API is no longer available in Maximo Assist. If the document query API is enabled and you are upgrading to Maximo Application Suite 9.0, this API is automatically removed during the upgrade.
Diagnosis API v2: You can complete tasks for diagnosis library management. For example, listing, creating, updating, deleting diagnosis libraries, knowledge, diagnosis models, and flows. With the diagnosis API, you can complete tasks for diagnosis data management such as listing, creating, updating, and deleting diagnosis data, and triggering diagnosis.; Note:
Starting in Maximo Application Suite 9.0, the diagnose function is no longer available in Maximo Assist. If the diagnose function is enabled and you are upgrading to Maximo Application Suite 9.0 this function and any associated diagnosis libraries are automatically removed during the upgrade.
Expert Group API: You can complete tasks such as listing all expert groups, and creating, getting, updating, and deleting expert groups.
Expertise API: You can complete tasks such as creating, listing, updating, and deleting expertise categories, attributes, and values.
Session Management API: You can complete tasks for collaborate session management. For example, you can create or delete sessions and configure sessions, generate session summaries, manage experts, and configure ICE servers.
Mapping API: You can complete tasks for mapping incoming collaborate requests to working context, such as creating, listing, updating, and deleting request-mapping definitions.