Universal CMDB REST API Reference
Notes:
To view the interactive REST API Reference documentation and to try executing the sample code for each REST API call, access CMS UI, and go to Help > REST API Reference.
In a classic version of UCMDB, make sure you add /rest-api to the beginning of the URL, so that it becomes /rest-api/authenticate; In a suite version, a further root context needs to be added, such as /cms for the SMAX suite, which results in /cms/rest-api/authenticate.
[ Jump to Models ]
Table of Contents
This call returns a token based on user credentials. (authenticateUser)
This call returns a token based on user credentials.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
post /changeReports/generate/all
Generates a change report on all attributes of the given CIs,generates a report that contains information about all attributes. (computeReportAll)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
The server was not found.
500
A system error occurred
503
Server is busy handling other requests
Up
post /changeReports/generate/blacklist
This call generate a change report about the attributes of the given CIs, generates a report that contains no information about the attributes written in list "attributes". (computeReportWithBlacklist)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
The server was not found.
500
A system error occurred
503
Server is busy handling other requests
Up
post /changeReports/generate/whitelist
Generates change report exclusively on the given attributes of the given CIs,generates a report that contains information just about the attributes written in list "attributes". (computeReportWithWhitelist)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
The server was not found.
500
A system error occurred
503
Server is busy handling other requests
Up
post /dataflowmanagement/credentials
Creates a credential. (addCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
post /dataflowmanagement/probes/{probename}/ranges
Creates ranges for the specified data flow probe. (addRangesByProbe)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
probename (required)
Path Parameter — The string that represents the probe name.
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
post /dataflowmanagement/credentials/{cm_credential_id}/availability
Checks whether the specified credential is available. (checkCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
cm_credential_id (required)
Path Parameter — The string that represents credential ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
delete /dataflowmanagement/probes
Deletes the specified data flow probes and their ranges. (deleteProbe)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Query parameters
probeNames (required)
Query Parameter — Names of the probes that you want to delete.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
delete /dataflowmanagement/probes/{probename}/ranges
Deletes ranges for the specified data flow probe. (deleteRangesByProbe)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
probename (required)
Path Parameter — The string that represents the probe name.
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
post /dataflowmanagement/credentials/uda/{cm_credential_id}/export
Exports UDA certificate files (agentca.pem and acstrust.cert). (exportUDACert)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
cm_credential_id (required)
Path Parameter — The string that represents the credential ID.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
get /dataflowmanagement/credentials/{cm_credential_id}
Gets details of the specified credential. (getCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
cm_credential_id (required)
Path Parameter — The string that represents the credential ID.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
get /dataflowmanagement/credentials
Gets details of all credentials. (getCredentials)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/domains
Gets all domains. (getDomainsSummary)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/ranges
Gets IP ranges by queried IP address. (getIpRangesByQueriedIp)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Query parameters
queriedIpAddress (optional)
Query Parameter — Gets ranges of the current probe that contains the specified IP address. The queried IP address can be partial.
domainNames (optional)
Query Parameter — Get probe list which are from input domains.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/probes
Gets the specified data flow probes. (getProbes)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Query parameters
queriedIpAddress (optional)
Query Parameter — Gets probes whose IP ranges contain the specified IP address. The queried IP address can be partial or complete.
domainNames (optional)
Query Parameter — Gets a list of probes that belong to the specified domains.
fields (optional)
Query Parameter — Gets the specified probe fields. Returns all if no field is specified. For example, probeName, description.
probeStatus (optional)
Query Parameter — Gets probe status.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/protocols
Gets details of all protocols. (getProtocolNames)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/protocols/{protocolname}
Gets the specified protocol attributes. (getProtocoluidefinition)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
protocolname (required)
Path Parameter — The string that represents the protocol name.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /dataflowmanagement/probes/{probename}
Gets details of the specified data flow probe and its ranges. (getRangesByProbe)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Result explanation In the returned range list, definitionType: 0/1 represents IP_RANGE/CIDR , rangeType: 0/1 represents DATA_CENTER/CLIENT, ipVersion: 0/1 represents IPV4/IPV6.
Path parameters
probename (required)
Path Parameter — The string that represents the probe name.
Query parameters
queriedIpAddress (optional)
Query Parameter — Gets ranges of the current probe that contains the specified IP address. The queried IP address can be partial or complete.
pageSize (optional)
Query Parameter — Page size of ranges. format: int32
pageNum (optional)
Query Parameter — Page number of ranges. format: int32
sortByField (optional)
Query Parameter — Select a field to sort the ranges.
orderByAsc (optional)
Query Parameter — Select true/false to sort the ranges by ascending/descending order.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
patch /dataflowmanagement/credentials
Updates the specified credentials index. (moveCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
delete /dataflowmanagement/credentials/{cm_credential_id}
Deletes the specified credential. (removeCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
cm_credential_id (required)
Path Parameter — The string that represents the credential ID.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
patch /dataflowmanagement/credentials/{cm_credential_id}
Updates the specified credential. (updateCredential)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
cm_credential_id (required)
Path Parameter — The string that represents the credential ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
patch /dataflowmanagement/probes/{probename}/ranges
Updates ranges for the specified data flow probe. (updateRangesByProbe)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for running discovery and integration inside UCMDB through the SDK.
Path parameters
probename (required)
Path Parameter — The string that represents the probe name.
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
This call creates entities as described by the payload. (create)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for modifying the data inside UCMDB through the SDK.
Request body
Query parameters
isGlobalId (optional)
Query Parameter —
forceTemporaryId (optional)
Query Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation.
400
Error while checking input
500
A system error occurred
Up
delete /dataModel/ci/{id}
This call deletes a CI. (deleteConfigurationItem)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for deleting the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a configuration item.
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
get /dataModel/ci/{id}
This call returns details of a CI. (getConfigurationItem)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for viewing the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a configuration item.
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
put /dataModel/ci/{id}
This call updates the details of a CI. (updateConfigurationItem)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for updating the data inside UCMDB through the SDK.
You have to specify only the properties that you want to update. Do not specify all properties of the CI.
You cannot update the type or the ID of the CI.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a configuration item.
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
get /dataModel/relatedCI/{id}
This call returns the details of the CIs related to the specified CI. (getConfigurationItem)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for viewing the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a configuration item.
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
withIcons (optional)
Query Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
delete /dataModel/relation/{id}
This call deletes a relation. (deleteRelation)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for deleting the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a relation.
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
get /dataModel/relation/{id}
This call returns the details of a relation. (getConfigurationItem)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for viewing the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a relation.
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
put /dataModel/relation/{id}
This call updates the details of a relation. (updateRelation)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for updating the data inside UCMDB through the SDK.
Path parameters
id (required)
Path Parameter — The string that represents the UCMDB ID of a relation.
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
404
Resources not found
500
Error while executing operation
Up
post /exposeCI/getInformation
REST APIs for exposing the cis information (getInformation)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
isGlobalId (optional)
Query Parameter — Represents the Global IDs of the CIs. The following values are available:
*true. Adds the global_id column in the output with its values (if it does not already exist in the given layout).
false. Displays the Global IDs of the CIs in the output, if the global_id column exists in the layout. Or, if the global_id column does not exist in the layout, then the Global IDs of the CIs are not displayed in the output.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
UCMDB exception
500
A system error occurred
Up
get /history/getChanges
Retrieve the list of changes occurred in the specified time frame. (getChanges)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
The method has 4 parameters, of which only 2 are mandatory: from & to. This two parameters represent the start and end time between which to retrieve history events.
A third parameter: changeType is a list parameter, meaning that 0 or more values can be specified. Possible values are: ADD_OBJECT, UPDATE_OBJECT, REMOVE_OBJECT, ADD_LINK, UPDATE_LINK, REMOVE_LINK, ADD_RELATION, REMOVE_RELATION.
If no value is specified for this parameter all events regardless of their type will be returned.
The forth parameter: id it's als a list parameter and can have 0 or more values. It represents the ids of CIs for which we want history events.
Query parameters
from (required)
Query Parameter — The time from when to retrieve events as timestamp in ms. format: int64
to (required)
Query Parameter — The time until when to retrieve events as timestamp in ms. format: int64
changeType (optional)
Query Parameter — The type of events were interested in.
Possible values are: ADD_OBJECT, UPDATE_OBJECT, REMOVE_OBJECT, ADD_LINK, UPDATE_LINK, REMOVE_LINK, ADD_RELATION, REMOVE_RELATION
id (optional)
Query Parameter — The list of UCMDB IDs for which history events should be retrieved.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
404
The server was not found or the value for changeType is not in the allowed domain.
500
A system error occurred
Up
post /history/getDataLayout
Return the layout at the specified date for the CIs that have one of the IDs provided. (getDataLayout)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The criteria for data layout. This criteria consists of date, ids and attributes.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
404
The server was not found or the value for changeType is not in the allowed domain.
500
A system error occurred
Up
get /history/getRemovedCIs
Returns the list of CIs removed in the specified time frame. (getRemovedCis)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Query parameters
from (required)
Query Parameter — The time from when to retrieve events as timestamp in ms. format: int64
to (required)
Query Parameter — The time until when to retrieve events as timestamp in ms. format: int64
ciType (required)
Query Parameter — CI Type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
404
The server was not found.
500
A system error occurred
Runs an impact analysis on the given definition. (runAnalysis)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
To check the available [severity] levels, see the output of GET /impactAnalysis/severities.
The impact definition should specify at least one trigger CI, and optionally a list of propertiesand a list of bundles. If no list of bundles is specified, All Bundles option is assumed by default.Each trigger CI should contain the triggerId and a severity. Severities have fixed naming, for thepossible inputs please use impactAnalysis/severities
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad Request
500
Error while executing operation
Up
get /integration/integrationpoints
Get all details of all integration points. (getAllIP)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
Integration point was not found.
500
A system error occurred
Up
get /integration/integrationpoints/{integrationId}
Get brief statistics of the integration point. (getIPBriefStatistics)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Path parameters
integrationId (required)
Path Parameter — The string that represents the integration point name.
Query parameters
detail (required)
Query Parameter — True to get all details of the integration point, false to get basic information of the integration point. default: false
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad request,input is not valid.
404
Integration point was not found.
500
A system error occurred
Up
patch /integration/integrationpoints/{integrationId}/jobs/{jobId}
Synchronize the specified integration job under an active integration point. Available for integration jobs under active integration point only. (operateIntegrationJob)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Run Discovery and integrations inside UCMDB through the SDK.
Path parameters
integrationId (required)
Path Parameter — The string that represents the integration point name.
jobId (required)
Path Parameter — The string that represents the job name.
Consumes
This API call consumes the following media types via the request header:
Query parameters
operationtype (required)
Query Parameter — Valid operation type values: population_full, population_delta, push_full, push_delta.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
401
Unauthorized to access
404
Resources not found
500
Error while executing operation
Up
get /integration/integrationpoints/{integrationId}/connectionstatus
Test connection of an integration point. (testIPConnection)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Path parameters
integrationId (required)
Path Parameter — The string that represents the integration point name.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
Resources not found
500
Error while executing operation or test connection failed
Up
patch /integration/integrationpoints/{integrationId}
Activate or deactivate an integration point. (updateIntegrationPoint)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Run Discovery and integrations inside UCMDB through the SDK.
Path parameters
integrationId (required)
Path Parameter — The string that represents the integration point name.
Consumes
This API call consumes the following media types via the request header:
Query parameters
enabled (required)
Query Parameter — True to activate an integration point, false to deactivate an integration point.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
401
Unauthorized to access
404
integration point not found
500
Error while executing operation
Up
get /metrics/discovery/{name}
Get the discovery performance metrics by pattern mactch. For example, "dispatch" (getPerformanceData)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Run Discovery and integrations inside UCMDB through the SDK.
Path parameters
name (required)
Path Parameter — The string that represents the metrics.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
500
A system error occurred
Up
post /multipleCmdb/convertToGlobalIds
Convert ucmdb ids to global ids (convertToGlobalIds)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of ucmdb ids
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation.Response contains mapping between ucmdb ids and global ids
400
Error in checking input. Most likely the input is not valid
500
A system error has occurred
Up
post /multipleCmdb/convertToUcmdbIds
Convert global ids to ucmdb ids (convertToUcmdbIds)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of global ids
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation.Response contains mapping between global ids and ucmdb ids
400
Error in checking input. Most likely the input is not valid
500
A system error has occurred
Up
post /packagemanager/packages
Deploys a package. (deployPackage)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (optional)
Form Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
post /packagemanager/packages/{packageName}/export
Exports a package to ZIP archive. (exportPackage)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
packageName (required)
Path Parameter — Package name
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
get /packagemanager/contentpacks
Gets information of all uploaded content packs. (getAvailableContentPackInfo)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Query parameters
all (optional)
Query Parameter — default: false
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
401
Unauthorized Access
500
Internal Server Error
Up
get /packagemanager/contentpacks/{CPVersion}
Gets the content pack version information. (getContentPackInfoByVersion)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
CPVersion (required)
Path Parameter — For example: 2019.08.104
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
get /packagemanager/packages
Gets details of all packages. (getPackageInfoList)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
401
Unauthorized Access
500
Internal Server Error
Up
get /packagemanager/packages/{packageName}
Gets details of a specific package. (getPackagesWithDetails)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
packageName (required)
Path Parameter — Package name
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
get /packagemanager/contentpacks/{CPVersion}/diffreport
Downloads content pack difference report. (getReport)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
CPVersion (required)
Path Parameter — For example: 2019.08.104
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
post /packagemanager/contentpacks/{CPVersion}
Simulates installation of or deploys the specified content pack with the option of generating a difference report. (installContentPack)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
CPVersion (required)
Path Parameter — For example: 2019.08.104
Consumes
This API call consumes the following media types via the request header:
Query parameters
generateReport (optional)
Query Parameter — default: true
deploy (optional)
Query Parameter — default: false
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Up
delete /packagemanager/packages/{packageName}
Undeploys a package. (undeployPackage)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Path parameters
packageName (required)
Path Parameter — Package name
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
404
Resources Not Found
500
Internal Server Error
Up
post /packagemanager/contentpacks
Uploads content pack binary. (uploadContentPack)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for Manage Packages inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (optional)
Form Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Operation
400
Bad Request
401
Unauthorized Access
500
Internal Server Error
Provides information about REST API services availability. (ping)
Provides information about REST API services availability.
Query parameters
restrictToWriter (optional)
Query Parameter — [boolean] - only returns available status if the server is in writer mode, if the server is reader return UNAVAILABLE status
restrictToReader (optional)
Query Parameter — [boolean] - only returns available status if the server is in reader mode, if the server is writer return UNAVAILABLE status
Responses
200
Server Up
503
Server Down
Exports to a file in CSV format the result obtained after policy calculation. (export)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Policy Definition
Query parameters
exportFormat (required)
Query Parameter — Export Format
query (optional)
Query Parameter — Query
limit (optional)
Query Parameter — Limit
TimeZone (optional)
Query Parameter — Time Zone
locale (optional)
Query Parameter — Locale
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Invalid export format
404
The server was not found.
500
Error while executing operation
Up
get /policy/getAllComplianceViews
Retrieves all compliance views names. (getAllComplianceViews)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
403
User is not allowed to access this API
404
The server was not found.
500
A system error occurred
Up
get /policy/getAllPolicies
Retrieves all policies names. (getAllPolicies)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
403
User is not allowed to access this API
404
The server was not found.
500
A system error occurred
Up
post /policy/chunkForPath
(getChunkForPath)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — View path specification
Query parameters
chunkSize (optional)
Query Parameter — The size of the chunk
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation.
400
An error occurred.
Up
get /policy/getComplianceView/{name}
Retrieves information regarding the compliance view, such as the name, the base view name and the policies list. (getComplianceView)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Path parameters
name (required)
Path Parameter — The name of the compliance view to retrieve
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
403
User is not allowed to access this API
404
The server was not found.
500
A system error occurred
Up
post /policy/expectedPropertiesForCi
(getExpectedPropertiesForCi)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — ci with policy details
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation.
400
An error occurred.
404
The server was not found.
500
A system error occurred
Retrieves information regarding the policies, such as the name, the path and the type of policy. (getPolicies)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
403
User is not allowed to access this API
404
The server was not found.
500
A system error occurred
Up
post /policy/saveComplianceView
Save a compliance view based on the specified name with the base view name and the policies list(name, base view name and the policies list are required). (saveComplianceView)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Error while checking input
403
User is not allowed to access this API
404
The server was not found.
500
A system error occurred
This call returns an example of data model structure that will be used in Data-In operations. (getSampleInput)
Return type
Example data
Content-Type: application/json
{
"cis" : [ {
"identifier" : "identifier",
"type" : "node or composition",
"properties" : "{\"name\":\"Test1\"}",
"ucmdbId" : "4dc01bee04c76cc0ac4bb069f46e8b56"
}, {
"identifier" : "identifier",
"type" : "node or composition",
"properties" : "{\"name\":\"Test1\"}",
"ucmdbId" : "4dc01bee04c76cc0ac4bb069f46e8b56"
} ],
"relations" : [ {
"end1Id" : "end1Id",
"end2Id" : "end2Id",
"type" : "node or composition",
"properties" : "{\"name\":\"Test1\"}",
"ucmdbId" : "4dc01bee04c76cc0ac4bb069f46e8b56"
}, {
"end1Id" : "end1Id",
"end2Id" : "end2Id",
"type" : "node or composition",
"properties" : "{\"name\":\"Test1\"}",
"ucmdbId" : "4dc01bee04c76cc0ac4bb069f46e8b56"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
TopologyData
Up
get /sampleTopologyQuery
REST API to execute topology queries (getSampleInput)
This call returns an example of the structure of an ad hoc TQL query. This structure can be used for future query related calls.
Return type
Example data
Content-Type: application/json
{
"nodes" : [ {
"layout" : [ "layout", "layout" ],
"hasComplexTypeCondition" : true,
"linkConditions" : [ {
"minCardinality" : "minCardinality",
"identifier" : "identifier",
"logicalOperator" : "and",
"linkIdentifier" : "linkIdentifier",
"linkType" : "linkType",
"conditions" : [ null, null ],
"maxCardinality" : "maxCardinality"
}, {
"minCardinality" : "minCardinality",
"identifier" : "identifier",
"logicalOperator" : "and",
"linkIdentifier" : "linkIdentifier",
"linkType" : "linkType",
"conditions" : [ null, null ],
"maxCardinality" : "maxCardinality"
} ],
"visible" : true,
"queryIdentifier" : "queryIdentifier",
"elementLabel" : "elementLabel",
"ids" : [ "ids", "ids" ],
"isContactNode" : true,
"attributeConditions" : [ {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
}, {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
} ],
"type" : "type",
"complexTypeConditions" : [ {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
}, {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
} ],
"includeSubtypes" : true
}, {
"layout" : [ "layout", "layout" ],
"hasComplexTypeCondition" : true,
"linkConditions" : [ {
"minCardinality" : "minCardinality",
"identifier" : "identifier",
"logicalOperator" : "and",
"linkIdentifier" : "linkIdentifier",
"linkType" : "linkType",
"conditions" : [ null, null ],
"maxCardinality" : "maxCardinality"
}, {
"minCardinality" : "minCardinality",
"identifier" : "identifier",
"logicalOperator" : "and",
"linkIdentifier" : "linkIdentifier",
"linkType" : "linkType",
"conditions" : [ null, null ],
"maxCardinality" : "maxCardinality"
} ],
"visible" : true,
"queryIdentifier" : "queryIdentifier",
"elementLabel" : "elementLabel",
"ids" : [ "ids", "ids" ],
"isContactNode" : true,
"attributeConditions" : [ {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
}, {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
} ],
"type" : "type",
"complexTypeConditions" : [ {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
}, {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
} ],
"includeSubtypes" : true
} ],
"folder" : [ "folder", "folder" ],
"bundleNames" : [ "bundleNames", "bundleNames" ],
"relations" : [ {
"layout" : [ "layout", "layout" ],
"hasComplexTypeCondition" : true,
"visible" : true,
"queryIdentifier" : "queryIdentifier",
"elementLabel" : "elementLabel",
"attributeConditions" : [ {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
}, {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
} ],
"from" : "from",
"to" : "to",
"type" : "type",
"complexTypeConditions" : [ {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
}, {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
} ],
"includeSubtypes" : true
}, {
"layout" : [ "layout", "layout" ],
"hasComplexTypeCondition" : true,
"visible" : true,
"queryIdentifier" : "queryIdentifier",
"elementLabel" : "elementLabel",
"attributeConditions" : [ {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
}, {
"identifier" : "identifier",
"not" : true,
"logicalOperator" : "and",
"valueType" : "valueType",
"attribute" : "attribute",
"conditions" : [ null, null ],
"value" : "{}",
"operator" : "isNull"
} ],
"from" : "from",
"to" : "to",
"type" : "type",
"complexTypeConditions" : [ {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
}, {
"exclude" : true,
"type" : "type",
"includeSubtypes" : true
} ],
"includeSubtypes" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
TopologyQuery
Up
post /serviceModeling/getServiceInformation
REST APIs for getting the modeling information (getServiceModelingInformation)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for related inside UCMDB through the SDK.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Bad request.
404
The server was not found.
500
A system error occurred
Executes the query stored in CMDB with the given name. (executeQueryByName)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for executing the TQL query inside UCMDB through the SDK.
Request body
Body Parameter — The name of the query to be calculated
Query parameters
chunkSize (optional)
Query Parameter — integer value that represents the chunk size of the result.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
500
A system error occurred
Up
post /topology/queryNameWithParameters
Executes the parametrized query stored in CMDB with the given name (executeQueryByNameWithParameters)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The name of the query to be calculated
Query parameters
chunkSize (optional)
Query Parameter — integer value that represents the chunk size of the result.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
The server was not found.
500
A system error occurred
503
Server is busy handling other requests
Up
get /topology/result/{id}/{chunkNumber}
This call retrieves a chunk from a chunked TQL query result. (getQueryResponse)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for executing the TQL queries by definition inside UCMDB through the SDK.
The user that created the result ID token must be the same as the one querying it.
Path parameters
id (required)
Path Parameter — The string that represents a token that identifies this resultId, retrieved from an execute query call when the resultSize bigger than chunkNumber.
chunkNumber (required)
Path Parameter — integer value that represents the chunk size of the result.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Invalid input
Up
delete /topology/result/{id}
This call deletes a chunked TQL query result from memory. (releaseChunk)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for executing the TQL queries by definition inside UCMDB through the SDK.
The user that created the result ID token must be the same one that deletes it.
Path parameters
id (required)
Path Parameter — The string that represents a token that identifies this resultId, retrieved from an execute query call when the resultSize bigger than chunkNumber.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
400
Invalid input
execute query by definition. (executeQuery)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Permission required The user that the token belongs to must have the required permissions for executing TQL queries by definition inside UCMDB through the SDK.
The visible attribute above specifies whether to return this node in the results or not.
The includeSubtypes attribute specifies whether to include the subtypes of this node type or not.
The layout attribute specifies which attributes of the objects will be returned (default: none).
The attributeConditions attribute specifies conditions on the properties of the objects or relationships. You can use simple attributes (name, operator, or value) or complex attributes (a logical operator and a list of attributes that are joined by that logical operator).
The linkConditions attribute specifies conditions on the links that the object participates into. You need to specify the link’s temporary ID and the cardinality. You can also use complex conditions that are made of a logical operator and a list of conditions.
The not property on the conditions specifies whether to negate the condition. If this property is unspecified, the default value is false.
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chunkSize (optional)
Query Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful operation
404
The server was not found.
500
A system error occurred
503
Server is busy handling other requests
[ Jump to Methods ]
Table of Contents
AddedRangeWrapper - AttributeCondition - AuthenticationDetails - CIFilter - CiWithPolicyDetails - ComplexTypeCondition - Condition - DataInConfigurationItem - DataInRelation - DataLayoutReq - ErrorCode - Filtering - HistoryReportInput - ImpactDefinition - LinkCondition - ModelingDetails - PackageOperationStatus - PathElement - PolicyDefinition - QueryNode - QueryRelationship - RangeWrapper - ReqEntry - ResourceInfo - ResourceOperationStatus - SortElement - TopologyData - TopologyQuery - Trigger - UpdatedRangeWrapper - ViewResultKeyWithChunkNumber - add ntadmin credential - body - body_1 - body_2 - check credential - move credential index - update ntadmin credential -
range
String If range's definition type is CIDR, then format is 1.1.1.1/32, else it is 1.1.1.1-1.1.1.1.
definitionType
String This is the IP range format,IP_RANGE or CIDR
CIDR
IP_RANGE
ipVersion
IPV4
IPV6
isIncluded (optional)
rangeType
String This is the lease time of ip range, DATA_CENTER or CLIENT
DATA_CENTER
CLIENT
description (optional)
attribute (optional)
operator (optional)
String One of the following strings: isNull, equals, isNotEqualTo, like, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, in, containsAny, contains. If this is unspecified, the default value is equals.
isNull
equals
isNotEqualTo
like
greaterThan
greaterThanOrEqual
lessThan
lessThanOrEqual
in
containsAny
contains
inIgnoreCase
equalsCaseInsensitive
likeCaseInsensitive
changedInLast
unchangedInLast
occursWithinHours
occursAfterHours
value (optional)
not (optional)
logicalOperator (optional)
String The string that represents a logic operator, which can be "and" or "or".
and
or
conditions (optional)
valueType (optional)
identifier (optional)
username
password
String password of the login user
clientContext (optional)
Integer client context id, this is optional format: int32
type
String The CI Type. This field cannot be empty or missing.
layout
array[String] The columns that will be displayed in the output. This field cannot be empty or missing.
includeSubtypes (optional)
sortBy (optional)
array[SortElement] A list of sorting conditions containing the name of the column after which the data will be sort, and the order in which the data is displayed. The order field can have the following values: ASC, or DESC.
filtering (optional)
Filtering The conditions used to filter the data.
ucmdbId (optional)
breachedPolicies (optional)
type (optional)
includeSubtypes (optional)
exclude (optional)
column (optional)
value (optional)
filteringAttributeCondOperator (optional)
IS_NULL
EQUALS
NOT_EQUALS
GREATER
GREATER_OR_EQUAL
LESS
LESS_OR_EQUAL
IN
IN_IGNORE_CASE
CONTAINS
CONTAINS_ANY
EQUALS_CASE_INSENSITIVE
LIKE
LIKE_CASE_INSENSITIVE
CHANGED_IN_LAST
UNCHANGED_IN_LAST
OCCURS_WITHIN_HOURS
OCCURS_AFTER_HOURS
ucmdbId
String The string that represents a temporary ID or UCMDB ID of the objects.
type
String The string that represents the name of a valid CI Type or relation Type from the UCMDB. You have to use the name of the Type, not the display name. The name of the Type can be found inside the CI Type Manager.
properties
map[String, Object] [ucmdb_cit_prop]:[ucmdb_cit_prop_value], [ucmdb_cit_prop] is the valid property name of the CI Type or relation Type. You have to use the name of the property, not its display name.[ucmdb_cit_prop_value] is the property value, which can be integer, string, Boolean, long, double, ISO8601 date, or a list of values depending on the property data type.
identifier (optional)
ucmdbId
String The string that represents a temporary ID or UCMDB ID of the objects.
type
String The string that represents the name of a valid CI Type or relation Type from the UCMDB. You have to use the name of the Type, not the display name. The name of the Type can be found inside the CI Type Manager.
properties
map[String, Object] [ucmdb_cit_prop]:[ucmdb_cit_prop_value], [ucmdb_cit_prop] is the valid property name of the CI Type or relation Type. You have to use the name of the property, not its display name.[ucmdb_cit_prop_value] is the property value, which can be integer, string, Boolean, long, double, ISO8601 date, or a list of values depending on the property data type.
end1Id (optional)
end2Id (optional)
data (optional)
layout (optional)
description (optional)
code (optional)
parametrizedError (optional)
errorParametersValues (optional)
logicalOperator (optional)
and
or
conditions (optional)
dateFrom
Date represents the date from which changes of attributes should be taken into consideration at the generated report format: date-time
dateTo
Date represents the limit date to which changes of attributes should be taken into consideration at the generated report. format: date-time
viewName
String is a view that has as result some CIs on which report will be based on.
attributes (optional)
array[String] is a list of attributes which should or should not appear in the generated report, this is not required when call API to generate a report that contains information about all attributes.
bundles (optional)
array[String] (Optional) Specify the bundles of rules used to run the analysis. If you do not specify a list of bundles, all bundles are used by default
triggerCIs
array[Trigger] Specify the CIs that are triggered for this impact analysis (as an array of trigger CIs). At least one trigger CI should be specified. Each trigger CI has two fields:triggerId: [ucmdb_id]The string that represents the CI's ID in UCMDB ; severity: [severity]The string that represents the severity at which the trigger CI is affected.
properties (optional)
array[String] (Optional) Specify the properties to be fetched for each affected CI that is identified by the impact analysis (as an array of strings - names). If not specified, no extra property will be fetched. The CI type and the UCMDB ID are fetched by default.
linkIdentifier (optional)
String The string that represents a temporary ID of the objects. This temporary object ID can be used for referring to the object inside this payload. For example, you can specify the two ends of a relationship, or use the relationship temp ID inside the link conditions.
minCardinality (optional)
String The string that represents the cardinality of a relationship end, which can be a number, *, or UNBOUNDED.
maxCardinality (optional)
String The string that represents the cardinality of a relationship end, which can be a number, *, or UNBOUNDED.
logicalOperator (optional)
String The string that represents a logic operator, which can be "and" or "or".
and
or
conditions (optional)
linkType (optional)
String type of current condition
identifier (optional)
errorCode (optional)
resourcesStatus (optional)
deploySuccessful (optional)
successResources (optional)
failedResources (optional)
name (optional)
pathElementId (optional)
pathElementType (optional)
pathElementName (optional)
name (optional)
String compliance view name used on calculating a saved compliance view
baseViewName (optional)
String view name used on calculating an ad-hoc compliance view
policyQueries (optional)
array[String] list of policy used on calculating an ad-hoc compliance view
linkConditions (optional)
type (optional)
String The string that represents the name of a valid CI Type from the UCMDB. You have to use the name of the CI Type, not the display name. The name of the CI Type can be found inside the CI Type Manager.
queryIdentifier (optional)
String The string that represents a temporary ID of the objects. This temporary object ID can be used for referring to the object inside this payload. For example, you can specify the two ends of a relationship, or use the relationship temp ID inside the link conditions.
visible (optional)
includeSubtypes (optional)
layout (optional)
array[String] List of ucmdb_cit_prop (ucmdb_cit_prop represents the valid property name of the CI Type. You can get the name and the list of all properties of a CI Type from the CI Type Manager.).
attributeConditions (optional)
elementLabel (optional)
String This string represents the Element Label of the query element
complexTypeConditions (optional)
hasComplexTypeCondition (optional)
ids (optional)
isContactNode (optional)
type (optional)
String The string that represents the name of a valid CI Type from the UCMDB. You have to use the name of the CI Type, not the display name. The name of the CI Type can be found inside the CI Type Manager.
queryIdentifier (optional)
String The string that represents a temporary ID of the objects. This temporary object ID can be used for referring to the object inside this payload. For example, you can specify the two ends of a relationship, or use the relationship temp ID inside the link conditions.
visible (optional)
includeSubtypes (optional)
layout (optional)
array[String] List of ucmdb_cit_prop (ucmdb_cit_prop represents the valid property name of the CI Type. You can get the name and the list of all properties of a CI Type from the CI Type Manager.).
attributeConditions (optional)
elementLabel (optional)
String This string represents the Element Label of the query element
complexTypeConditions (optional)
hasComplexTypeCondition (optional)
from (optional)
to (optional)
range
String If range's definition type is CIDR, then format is 1.1.1.1/32, else it is 1.1.1.1-1.1.1.1.
definitionType
String This is the IP range format,IP_RANGE or CIDR
CIDR
IP_RANGE
ipVersion
IPV4
IPV6
isIncluded (optional)
valid (optional)
date (optional)
ciIDs (optional)
currentVersion (optional)
data (optional)
qualifiedName (optional)
subSystemName (optional)
extension (optional)
absoluteName (optional)
noVersionSet (optional)
isFactory (optional)
cmdbVersion (optional)
updateTime (optional)
path (optional)
packageName (optional)
subSystemDisplayName (optional)
packageDisplayName (optional)
name (optional)
errorCode (optional)
deploySuccessful (optional)
resourceInfo (optional)
attribute (optional)
order (optional)
ASC
DESC
cis (optional)
relations (optional)
bundleNames (optional)
nodes (optional)
relations (optional)
folder (optional)
triggerId (optional)
severity (optional)
oldRanges (optional)
newRanges (optional)
viewExecutionId (optional)
path (optional)
search (optional)
chunkNumber (optional)
Represents an ntadmin credential in the system
credentialType
domainName (optional)
user_label (optional)
protocol_timeout (optional)
ntadminprotocol_service_startup (optional)
Represents an ntadmin credential in the system
credentialType
domainName (optional)
user_label (optional)
protocol_timeout (optional)
ntadminprotocol_service_startup (optional)
Update the specified credentials index
credentialType
domainName (optional)
fromCredentialId
fromProtocolIndex (optional)
Integer source credential index format: int32
moveToCredentialI
moveToProtocolIndex (optional)
Integer source credential index format: int32
Represents an ntadmin credential in the system, which need to update
credentialType
domainName (optional)
user_label (optional)
protocol_timeout (optional)
ntadminprotocol_service_startup (optional)
Checks whether the specified credential is available
probeName
ipAddress
timeout
Long time out format: int64
Update the specified credentials index
credentialType
domainName (optional)
fromCredentialId
fromProtocolIndex (optional)
Integer source credential index format: int32
moveToCredentialI
moveToProtocolIndex (optional)
Integer source credential index format: int32
Represents an ntadmin credential in the system, which need to update
credentialType
domainName (optional)
user_label (optional)
protocol_timeout (optional)
ntadminprotocol_service_startup (optional)