Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
Get Changes
This call retrieves the history changes occurred in a specified time frame.
URL
/history/getChanges
Method
GET
Headers
Required:
Authorization: Bearer <token>
Note <token> is the token that is returned by the Authentication call.
Example:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0
Request type
None
Response type
JSON
URL Parameters
Required:
[from]
The starting time for retrieving the events, measured in milliseconds. (Long)
[to]
The ending time for retrieving the events, measured in milliseconds. (Long)
Optional:
[change Type]
The types of changes you want to retrieve. The possible values are: ADD_OBJECT, UPDATE_OBJECT, REMOVE_OBJECT, ADD_LINK, UPDATE_LINK, REMOVE_LINK, ADD_RELATION, and REMOVE_RELATION. This parameter can be specified multiple times. (Set)
[id]
The list of UCMDB IDs for which history events should be retrieved. (Set)
For example:
https://localhost:8443/rest-api/history/getChanges?from=1475323669000&to=1476706069000&changeType=ADD_OBJECT https://localhost:8443/rest-api/history/getChanges?from=1475323669000&to=1476706069000&changeType=ADD_OBJECT&changeType=UPDATE_OBJECT&id=4d08b8a5e349a7fdba5ba5ff60f47929&id=476948c54e4a86e1a32bb83c41cdc7c5
Payload
None
Success response
Response: 200
Content:
{
"history": [
{
"id": "4d08b8a5e349a7fdba5ba5ff60f47929",
"changes": [
{
"time": 1476365233608,
"changer": "User:admin",
"dataStore": "UCMDB-UI",
"changeType": "ADD_OBJECT",
"data": {
"dataId": "4d08b8a5e349a7fdba5ba5ff60f47929",
"type": "nt",
"properties": {
"display_label": "windows-0001",
"track_changes": false,
"data_allow_auto_discovery": true,
"create_time": 1476365233752,
"global_id": "4d08b8a5e349a7fdba5ba5ff60f47929",
"name": "windows-0001",
"lic_type_udf": false,
"default_gateway_ip_address_type": "IPv4",
"is_save_persistency": false,
"lic_type_udi": false,
"data_source": "UCMDB-UI: User:admin",
"root_enableageing": false
}
}
},
{
"time": 1476365768785,
"changer": "User:{UISysadmin:UCMDB},LoggedInUser:{admin:UCMDB}",
"dataStore": "UCMDB",
"changeType": "UPDATE_OBJECT",
"data": {
"dataId": "4d08b8a5e349a7fdba5ba5ff60f47929",
"type": "nt",
"properties": {
"description": "decription 1"
}
}
},
{
"time": 1476438324892,
"changer": "User:{UISysadmin:UCMDB},LoggedInUser:{admin:UCMDB}",
"dataStore": "UCMDB",
"changeType": "UPDATE_OBJECT",
"data": {
"dataId": "4d08b8a5e349a7fdba5ba5ff60f47929",
"type": "nt",
"properties": {
"bios_source": "cosmos"
}
}
},
{
"time": 1476438334455,
"changer": "User:{UISysadmin:UCMDB},LoggedInUser:{admin:UCMDB}",
"dataStore": "UCMDB",
"changeType": "UPDATE_OBJECT",
"data": {
"dataId": "4d08b8a5e349a7fdba5ba5ff60f47929",
"type": "nt",
"properties": {
"bios_source": "cosmos-galaxy"
}
}
}
]
},
{
"id": "476948c54e4a86e1a32bb83c41cdc7c5",
"changes": [
{
"time": 1476365263533,
"changer": "User:admin",
"dataStore": "UCMDB-UI",
"changeType": "ADD_OBJECT",
"data": {
"dataId": "476948c54e4a86e1a32bb83c41cdc7c5",
"type": "nt",
"properties": {
"display_label": "windows-0002",
"track_changes": false,
"data_allow_auto_discovery": true,
"create_time": 1476365263534,
"global_id": "476948c54e4a86e1a32bb83c41cdc7c5",
"name": "windows-0002",
"lic_type_udf": false,
"default_gateway_ip_address_type": "IPv4",
"is_save_persistency": false,
"lic_type_udi": false,
"data_source": "UCMDB-UI: User:admin",
"root_enableageing": false
}
}
},
{
"time": 1476365784442,
"changer": "User:{UISysadmin:UCMDB},LoggedInUser:{admin:UCMDB}",
"dataStore": "UCMDB",
"changeType": "UPDATE_OBJECT",
"data": {
"dataId": "476948c54e4a86e1a32bb83c41cdc7c5",
"type": "nt",
"properties": {
"description": "description 2"
}
}
}
]
}
]
}
Error response
Status: 404, 500, or 400
Content:
{
error: [string]
}
Example:
Code: 404
Content:
{
error: The server was not found or the value for changeType is not in the allowed domain.
}
