UCMDB REST API Documentation
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 containerized version, make sure you add /ucmdb-server/rest-api to the beginning of the URL, so that it becomes /ucmdb-server/rest-api/authenticate.
Access
[ 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 /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
body (optional)
Body 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 /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
Body Parameter — Array[AddedRangeWrapper]
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/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.
versionCompatibility (optional)
Query Parameter — Gets probe by version compatibility.
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/ranges
Gets details of the specified data flow probe and its ranges. (getRanges)
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.
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.
filter (optional)
Query Parameter — It is a set of key-value pairs for filtering the results. Each of them has a relation 'AND' with others.
Valid keys can be seen in the following examples, values are in an array format except for searchKey.
Examples:
types=[DATA_CENTER, CLIENT], find out ip ranges in types 'DATA_CENTER' and 'CLIENT'.
probeNames=[probe1, probe2], find out ip ranges belong to these probes.
domainNames=[domain1, domain2], find out ip ranges in these domains.
groupNames=[myProfile1, myProfile2], find out ip ranges belong to these ip range groups.
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/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
body (optional)
Body 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
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
body (optional)
Body 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
404
Resources Not Found
500
Internal Server Error
Up
patch /dataflowmanagement/probes
Performs probe batch update operation (updateProbes)
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
Request body
Body Parameter — Probes to update.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
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. (createDataModel)
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 —
ignoreExisting (optional)
Query Parameter —
returnIdsMap (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
post /dataModel/demodatasets/{fileName}/import
Import Data Model(Cis) from File/Folder to UCMDB. (importDataset)
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.
Path parameters
fileName (required)
Path Parameter — Represents the file or folder name existing on the server. Only json and zip files types are supported. The zip file should contain json files.
Query parameters
failIfExists (optional)
Query Parameter — If true an exception will be thrown when the object already exits. Otherwise the operation will add all objects that it can, ignoring all exceptions default: false
ignoreCustomResources (optional)
Query Parameter — If true will skip adding the custom attributes or classes from the json file that do not exist in the class model.Modified default enums and list types are not ignored default: 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
400
Error while checking input
401
Unauthorized operation
404
The resource was not found.
500
A system error occurred
Up
get /dataModel/demodatasets
Lists all the files to be imported to UCMDB. (importFiles)
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
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
post /dataModel/ci/export/{id}
Export configuration item properties to a file (exportConfigurationItemProperties)
Can be used by a user to export one configuration item properties to CSV
Path parameters
id (required)
Path Parameter — The string that represents the ucmdbId of a configuration item.
Consumes
This API call consumes the following media types via the request header:
Query parameters
exportFormat (optional)
Query Parameter — The string that represents the export format type. default: CSV
includeAttributesQualifiers (optional)
Query Parameter — The boolean that represents if a configuration item should return only the properties visible for CMS UI with specific qualifiers. default: false
isGlobalId (optional)
Query Parameter — The boolean that represents if the ucmdbId is globalId.
shouldShowCitDisplayLabel (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
Invalid export format or configuration item id.
404
Resource 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
includeAttributesQualifiers (optional)
Query Parameter — The boolean that represents if a configuration item should return only the properties visible for CMS UI with specific qualifiers default: false
isGlobalId (optional)
Query Parameter — The string that represents if the UCMDB ID is globalID.
shouldShowCitDisplayLabel (optional)
Query Parameter — The boolean that represents if the CIT attribute should return the display label instead of name property 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 operation
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.
updateIfExactMatch (optional)
Query Parameter — The string that represents if update CI if there is multiple match.
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. (getConfigurationItemRelatedCI)
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. (getConfigurationItemRelation)
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
patch /discovery/triggers
trigger operation (asyncBatchOperateTrigger)
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.
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
202
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
patch /discovery/managementzones/{managementZoneId}/discoveryprofiles/{id}
Discovery activity operation. (asyncOperateDiscoveryActivity)
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
managementZoneId (required)
Path Parameter — The string that represents the zone id.
id (required)
Path Parameter — The string that represents the job group id.
Consumes
This API call consumes the following media types via the request header:
Query parameters
operation (required)
Query Parameter — activate, deactivate, rerun
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
202
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
patch /discovery/managementzones/{managementZoneId}/discoveryprofiles/{discoveryProfileId}/jobs/{id}
Job operation. (asyncOperateDiscoveryJob)
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
managementZoneId (required)
Path Parameter — The string that represents the zone id.
discoveryProfileId (required)
Path Parameter — The string that represents the job group id.
id (required)
Path Parameter — The string that represents the job id.
Consumes
This API call consumes the following media types via the request header:
Query parameters
operation (required)
Query Parameter — activate, deactivate, rerun
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
202
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
patch /discovery/managementzones/{id}
zone operation (asyncOperateZone)
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
id (required)
Path Parameter — The string that represents the zone id.
Consumes
This API call consumes the following media types via the request header:
Query parameters
operation (required)
Query Parameter — activate, deactivate, rerun
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
202
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
patch /discovery/iprangeprofiles
ip range group batch operation (batchOperateIpRangeProfile)
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.
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
post /discovery/credentialprofiles
Creates a credential group (createCredProfile)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
post /discovery/discoveryprofiles
Create a job group. (createDiscoveryProfile)
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.
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.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
post /discovery/iprangeprofiles
Create an ip range group (createIPProfile)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
post /discovery/managementzones
Creates management zones. (createManagementZone)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
post /discovery/scheduleprofiles
Create a schedule. (createSchedProfile)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
delete /discovery/credentialprofiles/{id}
Deletes the specified credential group (deleteCredProfile)
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
id (required)
Path Parameter — Credential group 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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
delete /discovery/discoveryprofiles/{id}
Delete the specified job group. (deleteDiscoveryProfile)
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
id (required)
Path Parameter — The URMId of the job group
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
delete /discovery/iprangeprofiles/{id}
delete an ip range group (deleteIpRangeProfile)
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
id (required)
Path Parameter — The URMId of the ip range group
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
delete /discovery/managementzones/{id}
Deletes the specified management zone. (deleteManagementZone)
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
id (required)
Path Parameter — The string that represents the zone id.
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
delete /discovery/scheduleprofiles/{id}
Delete the schedule. (deleteSchedProfile)
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
id (required)
Path Parameter — The resource id of the schedule
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/discoverymeta/jobs/{id}
Get default job details. (getAdapter)
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
id (required)
Path Parameter — The job 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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/triggers/{id}/communicationlog
Get communication log (getCommunicationLog)
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
id (required)
Path Parameter — The string that represents the trigger CI ID.
Query parameters
probeName (required)
Query Parameter — The string that represents the probe name.
zoneId (required)
Query Parameter — The string that represents the zone ID.
jobId (required)
Query Parameter — The string that represents the job ID.
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. Error while checking input
401
Unauthorized access
404
Resources not found(ZoneId or JobId or TriggerCIID)
500
A system error occurred
Up
get /discovery/credentialprofiles
Gets a list of all credential groups (getCredProfileList)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/credentialprofiles/{id}
Gets the specified credential group (getCredentialProfile)
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
id (required)
Path Parameter — Credential group 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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/discoverymetadata/jobmetadata
Get a list of discovery job metadata. (getDiscoveryJobMeta)
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.
Query parameters
fields (optional)
Query Parameter — Gets specific fields of discovery job metadata, return all if there is no specified. E.g jobDisplayName,adapterName
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/discoverymetadata/moduletree
Get the module tree. (getDiscoveryModuleTree)
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.
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
A system error occurred
Up
get /discovery/discoveryprofiles/{id}
Get the specified job group. (getDiscoveryProfile)
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
id (required)
Path Parameter — The URMId of the job group
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/discoveryprofiles
Get a list of job groups. (getDiscoveryProfileList)
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.
Query parameters
fields (optional)
Query Parameter — Gets specific fields of job groups, return all if there is no specified. E.g name,id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/results
Get discovery results (getDiscoveryResults)
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.
Query parameters
zoneId (required)
Query Parameter —
jobId (optional)
Query Parameter —
triggerId (optional)
Query Parameter —
citype (required)
Query Parameter —
fields (optional)
Query Parameter — CI attributes
start (optional)
Query Parameter — The record number of the first item returned. This is for pagination of the result set. The minimum value is 0.
It should be a non-negative integer. default: 0 format: int32
count (optional)
Query Parameter — The expected return count of result. This is for pagination of the result set.
It should be between 1 to 100. default: 100 format: int32
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/discoverymetadata/usecases
Get a list of discovery categories and options. (getDiscoveryTagMetadata)
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.
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
A system error occurred
Up
get /discovery/iprangeprofiles
Gets a list of ip range groups (getIPProfileList)
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.
Query parameters
ipaddress (optional)
Query Parameter — Search which ip range contains this ip address, the queried ip can be partial.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/iprangeprofiles/{id}
Get the specified ip range group (getIpRangeProfile)
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
id (required)
Path Parameter — Ip range group 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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/discoverymeta/jobs/questions
Gets the parameter questions for jobs (getJobParameterQuestion)
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.
Consumes
This API call consumes the following media types via the request header:
Query parameters
jobNames (optional)
Query Parameter — Get job parameter question list which are from job.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/discoverymeta/tags/questions
Get the questions for specified tags. (getJobQuestion)
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.
Consumes
This API call consumes the following media types via the request header:
Query parameters
tagNames (optional)
Query Parameter — Get job question list which are from tags.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/managementzones/{id}
Gets details of the specified management zone. (getManagementZoneDetail)
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
id (required)
Path Parameter — The string that represents the zone id.
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/managementzones
Gets a list of management zones. (getManagementZoneList)
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.
Query parameters
fields (optional)
Query Parameter — Allows specifying a subset of attributes to be included in the response
resourceId (optional)
Query Parameter — The resource id related to the zone. You can query zones related to a specified resource
resourceType (optional)
Query Parameter — Type of resource, currently we support these resource types: ipRangeProfile,credentialProfile,scheduleProfile,discoveryProfile
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/results/statistics
Gets result statistics details of the specified zone. (getResultStatistics)
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.
Query parameters
mzoneId (optional)
Query Parameter —
jobId (optional)
Query Parameter —
triggerId (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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/scheduleprofiles/{id}
Get the specified schedule. (getSchedProfile)
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
id (required)
Path Parameter — The URMId of the schedule
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/scheduleprofiles
Get a list of all schedules. (getSchedProfileList)
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.
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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
get /discovery/triggers/{id}
Gets details of the specified trigger. (getTriggerById)
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
id (required)
Path Parameter — The string that represents the trigger ID.
Query parameters
mzoneId (required)
Query Parameter —
jobId (required)
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
get /discovery/triggers
Gets details of triggers. (getTriggers)
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.
Query parameters
start (optional)
Query Parameter — The record number of the first item returned. This is for pagination of the result set. The minimum value is 0.
It should be a non-negative integer. default: 0 format: int32
count (optional)
Query Parameter — The expected return count of result. This is for pagination of the result set.
It should be between 1 to 500. default: 500 format: int32
sortField (optional)
Query Parameter — The field name for sorting.
Valid keys are 'ciLabel, mzoneId, jobId, jobGroupId, triggerCiTypeDisplayName, probeName, ipLabel, hostLabel, status'. default: ciLabel
orderByAsc (optional)
Query Parameter — It indicates whether the result is in ascending or descending order while the sortField is set. default: true
filter (optional)
Query Parameter — It is a set of key-value pairs for filtering the results. Each of them has a relation 'AND' with others.
Valid keys can be seen in the following examples, values are in an array format except for searchKey.
Examples:
mzoneIds=[test1, test2], find out triggers in zones 'test1' and 'test2'.
statuses=[PENDING, REACHED, SUCCESS, WARNING, ERROR], find out triggers in these statuses.
jobGroupIds=[myProfile1, myProfile2], find out triggers belong to these job groups.
jobIds=[Range IPs by ICMP, Host Connection by Shell], find out triggers belong to these jobs.
probeNames=[probe1, probe2], find out triggers belong to these probes.
searchKey=192.168.1, find out triggers by ip address or host 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. Error while checking input
401
Unauthorized access
500
A system error occurred
Up
put /discovery/credentialprofiles/{id}
Updates the specified credential group (updateCredProfile)
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
id (required)
Path Parameter —
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
put /discovery/discoveryprofiles/{id}
Update the specified job group. (updateDiscoveryProfile)
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
id (required)
Path Parameter —
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.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
put /discovery/iprangeprofiles/{id}
Update an ip range group (updateIPProfile)
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
id (required)
Path Parameter —
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
put /discovery/managementzones/{id}
Updates the specified management zone. (updateManagementZone)
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
id (required)
Path Parameter — The string that represents the zone 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.
application/json; charset=UTF-8
Responses
200
Successful operation
400
Bad request. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
put /discovery/scheduleprofiles/{id}
Update the specific schedule. (updateSchedProfile)
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
id (required)
Path Parameter —
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. Error while checking input
401
Unauthorized access
404
Resources not found
500
A system error occurred
Up
post /discoveryintegration/export
Export discovery configuration to a file. (exportDiscoveryResources)
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
categories (required)
Query Parameter — The resource type to be exported.
format (required)
Query Parameter — The resource format to be exported.
password (required)
Query Parameter — Password to encrypt the exported file.
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 /discoveryintegration/import
Import discovery configuration from a provided file . (importDiscoveryResources)
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
password (required)
Query Parameter — Password to encrypt the exported file.
allowConflict (required)
Query Parameter — Allow conflict for ranges and profiles or not. default: true
format (required)
Query Parameter — The file format to import.
Form parameters
file (required)
Form Parameter — The file to import.
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 /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
Query parameters
showRelations (optional)
Query Parameter — showRelations default: false
isGlobalId (optional)
Query Parameter — isGlobalId 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
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
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
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
Server Up
503
Down
Up
post /policy/calculate
Calculates a baseline or topology policy. There are two ways in which we can calculate a policy: calculate a saved compliance view or an ad-hoc compliance view.The viewResultId returned should be used to retrieve the actual calculation results (calculatePolicy)
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
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
Error while checking input
401
Unauthorized access
404
The server was not found.
417
Expectation Failed
500
A system error occurred
Delete a policy by name (deletePolicy)
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:
Query parameters
policyName (required)
Query Parameter — The name of the policy to be deleted. This will also delete all the compliance views that contain this policy
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
401
Unauthorized access
404
The server was not found.
500
A system error occurred
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/complianceViews
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.
Query parameters
fields (optional)
Query Parameter — Allows specifying only a subset of attributes (the name) to be included in the response
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
401
Unauthorized access
404
The server was not found.
500
A system error occurred
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.
Query parameters
fields (optional)
Query Parameter — Allows specifying a subset of attributes to be included in the response
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
401
Unauthorized access
404
The server was not found.
500
A system error occurred
Up
post /policy/chunkForPath
It is used to retrieve the detailed non compliant result of a policy calculation. This means that each item will have the reason why it is not compliant (getChunkForPath)
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 — 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.
404
The server was not found.
500
A system error occurred
Up
get /policy/complianceView/{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
401
Unauthorized access
404
The server was not found.
500
A system error occurred
Up
post /policy/expectedPropertiesForCi
Retrieves the expected properties for a not compliant ci (getExpectedPropertiesForCi)
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 — 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
Up
post /policy/complianceView
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
401
Unauthorized access
404
The server was not found.
500
A system error occurred
Up
get /report/change/ci/{viewName}/results
Generates a ci change report for the given viewName CI results within the specified time frame and according to the given filter (ciChangeReportResults)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Path parameters
viewName (required)
Path Parameter — View name
Query parameters
filter (required)
Query Parameter — Filter to be used which includes filter type: ALL,INCLUDE,EXCLUDE and attributes:name,description which represent the attributes to be included or excluded from the report , example: type=INCLUDE&attributes=description,name default: type=ALL
dateFrom (required)
Query Parameter — Represents the date from which changes of attributes should be taken into consideration at the generated report format: int64
dateTo (required)
Query Parameter — Represents the limit date to which changes of attributes should be taken into consideration at the generated report format: int64
start (optional)
Query Parameter — The index of the first item to be displayed format: int32
pageSize (optional)
Query Parameter — The page size format: int32
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
401
Unauthorized operation
404
The resource was not found.
500
A system error occurred
Up
get /report/change/view/{viewName}/results
Generates a view change report for update operations on the given viewName CI results within the specified time frame and according to the given filter (viewChangeReportResults)
Header required Authorization: Bearer (token), where (token) is the token that is returned by the Authentication call.
Path parameters
viewName (required)
Path Parameter — View name
Query parameters
filter (required)
Query Parameter — Filter to be used which includes filter type: ALL,INCLUDE,EXCLUDE and attributes:name,description which represent the attributes to be included or excluded from the report , example: type=INCLUDE&attributes=description,name default: type=ALL
dateFrom (required)
Query Parameter — Represents the date from which changes of attributes should be taken into consideration at the generated report format: int64
dateTo (required)
Query Parameter — Represents the limit date to which changes of attributes should be taken into consideration at the generated report format: int64
start (optional)
Query Parameter — The index of the first item to be displayed format: int32
pageSize (optional)
Query Parameter — The page size format: int32
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
401
Unauthorized operation
404
The resource 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
{"empty": 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
TopologyData
Up
get /sampleTopologyQuery
REST API to execute topology queries (getSampleInputForQuery)
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
{"empty": 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
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
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
[ Jump to Methods ]
Table of Contents
AddedRangeWrapper - AttributeCondition - AuthenticationDetails - CIFilter - ComplexTypeCondition - Condition - CredentialItemWrapper - CredentialProfileWrapper - DataInConfigurationItem - DataInRelation - DataLayoutReq - DiscoveryActivityItemWrapper - DiscoveryJobWrapper - DiscoveryProfileWrapper - ErrorCode - ExcludeIpRangeWrapper - Filtering - ImpactDefinition - Information that defines a compliance view. When used for calculation or export either the name property OR baseViewName and policyQueries properties must be populated - Information that defines a not compliant item and the policies applied in a policy calculation. This is used to show the reason why a configuration item is not compliant in relation to the policies applied - IpRangeItemWrapper - IpRangeProfileItemWrapper - IpRangeProfileWrapper - LinkCondition - ManagementZoneWithResourceWrapper - ManagementZoneWrapper - ModelingDetails - PackageOperationStatus - Path to retrieve the items from a view result or from a policy calculation result - QueryNode - QueryRelationship - RangeItemWrapper - RangeListWrapper - RangeWrapper - ReqEntry - ResourceInfo - ResourceOperationStatus - RunDuringTimeRangeWrapper - ScheduleDetailWrapper - ScheduleProfileWrapper - ServiceResult - SortElement - TimeRangeWrapper - TopologyData - TopologyQuery - Trigger - TriggerListWrapper - UpdateProbeWrapper - UpdatedRangeWrapper - ViewResultKeyWithChunkNumber - ZoneWithReferenceResourceWrapper - addNtadminCredential - checkCredential - moveCredentialIndex - updateNtadminCredential -
probe (optional)
String The probe name of this range.
example: DataFlowProbe
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.
example: 1.1.1.1-1.1.1.2
definitionType (optional)
String This is the IP range format,IP_RANGE or CIDR, default is IP_RANGE
CIDR
IP_RANGE
example: IP_RANGE
ipVersion (optional)
String IPV4 or IPV6, default is IPV4
IPV4
IPV6
example: IPV4
isIncluded (optional)
Boolean True means this is a included range, false means this is a excluded range, default is true.
example: true
rangeType (optional)
String This is the lease time of ip range, DATA_CENTER or CLIENT, default is DATA_CENTER
DATA_CENTER
CLIENT
example: DATA_CENTER
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
example: admin1
password
String password of the login user
example: password1
repository (optional)
example: UCMDB
clientContext (optional)
Integer client context id, this is optional format: int32
example: 1
type
String The CI Type. This field cannot be empty or missing.
example: node
layout
array[String] The columns that will be displayed in the output. This field cannot be empty or missing.
example: "[\"display_label\",\"name\",\"description\", \"node_role\", \"contextmenu\",\"global_id\"]"
includeSubtypes (optional)
example: false
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.
example: "[{\"attribute\": \"name\",\"order\": \"DESC\"}]"
filtering (optional)
Filtering The conditions used to filter the data.
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
domain (optional)
protocols (optional)
name (optional)
credentials (optional)
ucmdbId
String The string that represents a temporary ID or UCMDB ID of the objects.
example: 4dc01bee04c76cc0ac4bb069f46e8b56
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.
example: node or composition
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.
example: "{\"name\":\"Test1\"}"
attributesQualifiers
map[String, Object] [ucmdb_cit_attr]: {[ucmdb_cit_attr_qualifiers]}.[ucmdb_cit_attr] is the valid property name of the CI Type. You have to use the name of the property, not its display name.[ucmdb_cit_attr_qualifiers] is the qualifiers of the attribute
example: "\"memory_size\": {\n \"PROPERTIES_GROUP_NUMBER\": 0,\n \"PREVIEW_MODE_VISIBLE\": false\n }"
displayLabel (optional)
String The string that represents the display label of a UCMDB CI
identifier (optional)
ucmdbId
String The string that represents a temporary ID or UCMDB ID of the objects.
example: 4dc01bee04c76cc0ac4bb069f46e8b56
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.
example: node or composition
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.
example: "{\"name\":\"Test1\"}"
attributesQualifiers
map[String, Object] [ucmdb_cit_attr]: {[ucmdb_cit_attr_qualifiers]}.[ucmdb_cit_attr] is the valid property name of the CI Type. You have to use the name of the property, not its display name.[ucmdb_cit_attr_qualifiers] is the qualifiers of the attribute
example: "\"memory_size\": {\n \"PROPERTIES_GROUP_NUMBER\": 0,\n \"PREVIEW_MODE_VISIBLE\": false\n }"
displayLabel (optional)
String The string that represents the display label of a UCMDB CI
end1Id (optional)
end2Id (optional)
data (optional)
layout (optional)
example: "[\"name\", \"description\", \"bios_tag\"]"
discoveryProfileId (optional)
scheduleProfileId (optional)
credentialProfileId (optional)
jobName (optional)
jobDisplayName (optional)
adapterName (optional)
inputCI (optional)
jobType (optional)
protocols (optional)
jobParameters (optional)
triggerQueries (optional)
jobInvokeOnNewTrigger (optional)
name (optional)
description (optional)
jobs (optional)
description (optional)
code (optional)
parametrizedError (optional)
errorParametersValues (optional)
start (optional)
end (optional)
logicalOperator (optional)
and
or
conditions (optional)
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
example: "[\"bundle1\",\"bundle2\",...]"
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.
example: "[{\"triggerId\":[ucmdb_id],\"severity\":[severity]}, ...]"
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.
example: "[\"name\",\"label\",...]"
name (optional)
String compliance view name (used for calculating a saved compliance view)
example: complianceView1
baseViewName (optional)
String view name (used for calculating an ad-hoc compliance view)
example: baseTestingView1
policyQueries (optional)
array[String] list of policies (used for calculating an ad-hoc compliance view)
ucmdbId
String The string that represents the UCMDB ID of a configuration item
breachedPolicies
array[String] The list of policies that were applied in order to determine that the configuration item is not compliant
rangeCategory (optional)
start (optional)
end (optional)
excludeIpRanges (optional)
ipType (optional)
example: false
cidrMask (optional)
ipRangeProfileId (optional)
name (optional)
ranges (optional)
oob (optional)
example: false
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)
name (optional)
activated (optional)
ipRangeProfiles (optional)
discoveryActivities (optional)
description (optional)
name (optional)
activated (optional)
ipRangeProfiles (optional)
discoveryActivities (optional)
ucmdbId
example: 409891d38de4ef7e842990f436bb4478
chunkSize
example: 2000
name (optional)
errorCode (optional)
successResources (optional)
failedResources (optional)
deploySuccessful (optional)
resourcesStatus (optional)
pathElementId
String path id for retrieving the results from a view result
example: NON-COMPLIANT
pathElementType
String path type for retrieving the results from a view result
example: NON-COMPLIANT
pathElementName (optional)
String path name for retrieving the results from a view result
example: NON-COMPLIANT
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)
watch (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)
watch (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)
domainName (optional)
clusterName (optional)
example: false
probeName (optional)
ipRanges (optional)
operation (optional)
groups (optional)
ranges (optional)
probe (optional)
String The probe name of this range.
example: DataFlowProbe
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.
example: 1.1.1.1-1.1.1.2
definitionType (optional)
String This is the IP range format,IP_RANGE or CIDR, default is IP_RANGE
CIDR
IP_RANGE
example: IP_RANGE
ipVersion (optional)
String IPV4 or IPV6, default is IPV4
IPV4
IPV6
example: IPV4
isIncluded (optional)
Boolean True means this is a included range, false means this is a excluded range, default is true.
example: true
valid (optional)
date (optional)
example: 1476365233608
ciIDs (optional)
example: "[\"495a4faf96729548a2603046dbf7efd9\", \"476948c54e4a86e1a32bb83c41cdc7c5\"]"
data (optional)
currentVersion (optional)
path (optional)
name (optional)
packageName (optional)
extension (optional)
cmdbVersion (optional)
qualifiedName (optional)
updateTime (optional)
isFactory (optional)
absoluteName (optional)
noVersionSet (optional)
subSystemName (optional)
subSystemDisplayName (optional)
packageDisplayName (optional)
errorCode (optional)
resourceInfo (optional)
deploySuccessful (optional)
type
always
timeRange
alwaysRunBetween
example: always
timeRange (optional)
alwaysRunBetween (optional)
invocationTime (optional)
intervalUnit (optional)
interval (optional)
invocationHours (optional)
daysOfWeek (optional)
monthsOfYear (optional)
daysOfMonth (optional)
cronExpr (optional)
name (optional)
generateFrom (optional)
scheduleDetail (optional)
runDuringTimeRange (optional)
startTime (optional)
endTime (optional)
timeZone (optional)
code (optional)
message (optional)
parameters (optional)
attribute (optional)
order (optional)
ASC
DESC
mon (optional)
tue (optional)
wed (optional)
thu (optional)
fri (optional)
sat (optional)
sun (optional)
cis (optional)
relations (optional)
name (optional)
bundleNames (optional)
nodes (optional)
relations (optional)
folder (optional)
recalcPriority (optional)
jobId (optional)
mzoneId (optional)
triggerCiId (optional)
triggerCiType (optional)
operation (optional)
triggerItems (optional)
probeName (optional)
upgradeStatus (optional)
oldRanges (optional)
newRanges (optional)
viewExecutionId
String viewResultId value returned by calculation
path
search (optional)
String used to filter the records from the given path
example: node1
chunkNumber
Integer the chunk number for which the results should be retrieved format: int32
example: 1
zone (optional)
discoveryProfiles (optional)
scheduleProfiles (optional)
ipRangeProfiles (optional)
credentialProfiles (optional)
warnings (optional)
Represents an ntadmin credential in the system
credentialType
example: ntadminprotocol
domainName (optional)
example: DefaultDomain
user_label (optional)
example: ntadminExample
protocol_timeout (optional)
example: 20000
ntadminprotocol_service_startup (optional)
example: LocalService
Checks whether the specified credential is available
probeName
example: testProbe
ipAddress
example: 192.168.1.1
timeout
Long time out format: int64
example: 60000
Update the specified credentials index
credentialType
example: ntadminprotocol
domainName (optional)
example: DefaultDomain
fromCredentialId
example: *_*_CMS
fromProtocolIndex (optional)
Integer source credential index format: int32
example: 1
moveToCredentialI
example: *_*_CMS
moveToProtocolIndex (optional)
Integer source credential index format: int32
example: 2
Represents an ntadmin credential in the system, which need to update
credentialType
example: ntadminprotocol
domainName (optional)
example: DefaultDomain
user_label (optional)
example: ntadminExample
protocol_timeout (optional)
example: 30000
ntadminprotocol_service_startup (optional)
example: LocalService