Task 5: Enable the RESTful APIs for Custom CI Types in Service Manager

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)`

If your existing UCMDB-SM integration environment uses any custom CI types, you need to update the External Access Definition of each custom CI type in Service Manager to enable its RESTful API for using a generic adapter. A Service Manager generic adapter requires the ucmdbIntegration RESTful APIs to work.

The following table describes the parameters that you need to update in each External Access Definition in Service Manager (System Administration > Tailoring > Web Services > External Access Definition).

Parameter	Description	Example Value
RESTful Enabled	Enables the RESTful API (must be set to true to enable the RESTful API)	true
Resource Collection Name	Specifies a unique name for the resource collection. The following convention is recommended: <WS Object Name>+'s'	ucmdbATMs
Resource Name	Specifies a name for the resource. The following convention is recommended: <WS Object Name>	ucmdbATM
Unique Keys	Unique keys of the relevant device table	logical.name
Max Records Returned in Query	Maximum number of returned records in one query	1000
Resource Collection Actions - POST	Action to invoke for a POST request on the resource collection	Create
Resource Actions - POST	Action to invoke for a POST request on the resource	Create
Resource Actions - PUT	Action to invoke for a PUT request on the resource	Update
Resource Actions - DELETE	Action to invoke for a DELETE request on the resource	Delete

Parameter

Description

Example Value

RESTful Enabled

Enables the RESTful API (must be set to true to enable the RESTful API)

true

Resource Collection Name

Specifies a unique name for the resource collection. The following convention is recommended: <WS Object Name>+'s'

ucmdbATMs

Resource Name

Specifies a name for the resource. The following convention is recommended: <WS Object Name>

ucmdbATM

Unique Keys

Unique keys of the relevant device table

logical.name

Max Records Returned in Query

Maximum number of returned records in one query

1000

Resource Collection Actions - POST

Action to invoke for a POST request on the resource collection

Create

Resource Actions - POST

Action to invoke for a POST request on the resource

Create

Resource Actions - PUT

Action to invoke for a PUT request on the resource

Update

Resource Actions - DELETE

Action to invoke for a DELETE request on the resource

Delete

To access these parameters, follow these steps:

Open the External Access Definition for the custom CI type.

Click Tailoring > Web Services > Web Service Configuration to open the External Access Definition form.
In the Service Name field, type ucmdbIntegration.
In the Name field, select the table for the custom CI type.
In the Object Name field, type the relevant web service object name.
Click Search.

Click the Restful tab, and update the parameters.

As an example, the following figure shows the external access definition of a custom CI type named ATM Machine.