Develop > Developer Reference > Using APIs > Universal CMDB Web Service API > Universal CMDB Web Service API Overview

 Universal CMDB (UCMDB) Web Service API Overview

The Universal CMDB Web Service API is used to integrate applications with the  Universal CMDB (UCMDB). The API provides methods to:

  • Add, remove, and update CIs and relations in the CMDB

  • Retrieve information about the class model

  • Retrieve impact analysis

  • Retrieve information about configuration items and relationships

  • Manage credentials: view, add, update, and remove

  • Manage jobs: view status, activate, and deactivate

  • Manage triggers: add or remove a trigger CI, and add, remove, or disable a trigger TQL

  • View general data on domains and Probes

Methods for retrieving information about configuration items and relationships generally use the Topology Query Language (TQL). For details, see Topology Query Language.

Users of the Universal CMDB Web Service API should be familiar with:

  • The SOAP specification

  • An object-oriented programming language such as C++, C# or Java

  • Universal CMDB

  • Data Flow Management

ClosedUses of the API

The UCMDB Web Services API is used to fulfill a number of business requirements. For example:

  • A third-party system can query the class model for information about available configuration items (CIs).

  • A third-party asset management tool can update the CMDB with information available only to that tool, thereby unifying its data with data collected by applications.

  • A number of third-party systems can populate the CMDB to create a central CMDB that can track changes and perform impact analysis.

  • A third-party system can create entities and relations according to its business logic, and then write the data to the CMDB to take advantage of the CMDB query capabilities.

  • Other systems, such as the Release Control (CCM) system, can use the Impact Analysis methods for change analysis.

ClosedPermissions

To access the WSDL file for the web service, go to: http://localhost:8080/axis2/services/UcmdbService?wsdl. You will need to provide server administrator user credentials to view the WSDL file.

Note The Axis2 administration console is not accessible.

The user must have the Run Legacy API general action permission in order to log in.

The following table displays the additional required permissions for each Web Service API command:

Web Service API command Required Permissions
addCIsAndRelations
deleteCIsAndRelations
updateCIsAndRelations 		General Action: Data Update
executeTopologyQueryByName(AdHoc) executeTopologyQueryByNameWithParameters(AdHoc) executeTopologyQueryWithParameters(AdHoc)

General Action: Run Query by Definition

For each query: View permission

getTopologyQueryExistingResultByName getTopologyQueryResultCountByName
releaseChunks
pullTopologyMapChunks
getCINeighbours
getFilteredCIsByType
getCIsById
getCIsByType
getRelationsById

General Action: View CIs

For each query: View permission

getQueryNameOfView

General Action: View CIs

For each view: View permission

getChangedCIs General Action: View History, View CIs
calculateImpact
getImpactPath
getImpactRulesByGroupName
getImpactRulesByNamePrefix 		General Action: Run Impact Analysis
getAllClassesHierarchy
getClassAncestors
getCmdbClassDefinition 		None

Note When the root context has been changed in UCMDB, follow these steps to enable access to the Web Service API:

  1. Open the C:\UCMDB\UCMDBServer\deploy\axis2\WEB-INF\web.xml configuration file and locate the following section:

    </servlet>
    <servlet>
        <servlet-name>AxisRESTServlet</servlet-name>
        <display-name>Apache-Axis Servlet (REST)</display-name>
        <servlet-class>org.apache.axis2.transport.http.AxisRESTServlet</servlet-class>
    </servlet>
    <servlet>
        <servlet-name>AxisAdminServlet</servlet-name>
        <display-name>Apache-Axis AxisAdmin Servlet (REST)</display-name>
        <servlet-class>org.apache.axis2.transport.http.AxisAdminServlet</servlet-class>
    </servlet>

    Add the following lines after that:

    <init-param>
        <param-name>axis2.find.context</param-name>
        <param-value>false</param-value>
    </init-param>

  2. Open the C:\UCMDB\UCMDBServer\deploy\axis2\WEB-INF\conf\axis2.xml configuration file and locate the following line:

    <parameter name="enableSwA" locked="false">false</parameter>

    Add the following line after it:

    <parameter name="contextRoot" locked="false">test1/setup1/axis2
</parameter>

    where test1/setup1 is your root context.

    (To remove the root context, remove the text added to the path.)

  3. Restart the UCMDB server.

Send Help Center feedback