Web Services

New Operations

These new operations are available in the Web Services module of the Processes & Automation group:

• ConfigItem::ConfigItemCreate

• ConfigItem::ConfigItemDelete

• ConfigItem::ConfigItemGet

• ConfigItem::ConfigItemSearch

• ConfigItem::ConfigItemUpdate

To use these operations:

1. Add or edit a web service.

2. Select a Network transport in the OTRS as provider widget and save the web service.

3. The new operations are available in the Add Operation field of the OTRS as provider widget.

Examples for Usage

The following examples give a quick look about how to use the API for basic actions.

1. Create configuration item

   • URL: /api/agent/config-item/create

   • Method: POST

   • Payload:

     {
         "ConfigItem": {
             "Class": "Computer",
             "Name": "test name for new config item",
             "DeplState": "Production",
             "InciState": "Operational",
             "CIXMLData": {
                 "Seriennummer": "SNR1"
                 "NIC": {
                      "NIC": "test",
                      "IPoverDHCP": "Yes"
                 }
             }
         }
     }
     

2. Update configuration item

   • URL: /api/agent/config-item/4/update where 4 is the ID of the configuration item to be updated

   • Method: POST

   • Payload:

     {
         "ConfigItemID": "4",
         "ConfigItem": {
             "Class": "Computer",
             "Name": "test name for new config item",
             "DeplState": "Production",
             "InciState": "Operational",
             "CIXMLData": {
                 "Seriennummer": "SNR2"
                 "NIC": {
                      "NIC": "test",
                      "IPoverDHCP": "Yes"
                 }
             }
         }
     }
     

   Note

   The Class is required to be transmitted but will not affect the configuration item when updating. If you update a configuration item in the class Location and transmit the class Computer the configuration item will stay in the class Location.

3. Get configuration item

   • URL: /api/agent/config-item/4 where 4 is the ID of the configuration item to be fetched

   • Method: GET

4. List configuration items

   • URL: /api/agent/config-item/list

   • Method: POST