How to consume identification

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.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

The identification web service is an integral part of Service Management's synchronization with UCMDB. It is also available as a separate web service for you to use with other databases holding configuration item details.

The URL for Identification is: http://<host:port>/ess-webapp/rest/<TenantID>/identification/<taskId>

Note

You should replace <taskId> with a suitable string. For example: "MyFirstTask". The task Id appears in log entries and error messages.
To update the Service Management records, you may add one of the following to the end of the URL:
- /ADD_OR_UPDATE
  This creates all configuration item (CI) types identified as new and updates all CI types identified as existing.
- /REMOVE
  All CI types identified as existing are marked as missing.
The HTTP request should be a POST request, and its body should contain, in JSON format, the CI type which you want to identify. For more information, see the following example.

Example of configuration item (CI) type input

The body of the POST request should contain a collection of CI types in JSON format.

The following example shows a collection with one CI type to identify:

[{"entity_type":"Device",
 "properties":
       {"Name":"First Device",
	 "Id":"abcdef0123456789",
	 "DomainName":"Domain1",
        "HostName":"1st Device",
        "Cpus":"{"Cpu":[
            {"CpuId":"3","CpuVendor":"Incoming Vendor",
             "Id":"bbbbbb1111111111"},
            {"CpuId":"4","Id":"aaaaaa0000000000"}
            ]}"
       }
}]

In the example:

Id is the Service Management ID, and is optional. You should only include this if you are sure you have the correct ID.

entity_type is required, and is the relevant Service Management CI type. This may be different from the UCMDB CI type.

properties contains key-value pairs: one for each property of the CI whose value is known.