Documentation Index

Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt

Use this file to discover all available pages before exploring further.

Update CIs in CMDB

Prev Next

You can update a Configuration Item (CI) in the CMDB if you are a Configuration Manager or user with appropriate access. Use the following API Requests to update the Configuration Item (CI) in the CMDB.

Service Name

HTTP Method

CMDB_CreateOrUpdateCIDetails

POST


Below are the sample requests for different CIs.

Sample Request

{
    "ServiceName": "CMDB_CreateOrUpdateCIDetails",
    "objCommonParameters": {
        "_ProxyDetails": {
            "Password": "test@123",
            "ProxyID": 0,
            "ReturnType": "JSON",
            "UserName": "john@xyz.com"
        },
        "_CMDBDetails": {
            "Configuration_Id": 372,
            "InstanceName": "Info",
            "Device_Host_Name": "Device1234567895588",
            "Serial_No": "SerNoin9012345789014408",
            "Owner_Workgroup_Name": "IT Servicedesk",
            "Owner_Name": "john@xyz.com",
            "Managed_By": "IT Servicedesk",
            "Classification": "Storage\\HDD Storage",
            "Status": "Development",
            "LifeCycleStatus": "Design",
            "Criticality_Name": "high",
            "Customer": "XYZ",
            "VendorName": "Lenovo",
            "LocationName": "Bangalore",
            "Make": "HP",
            "Mac_Address": "3E:45:DT:G6",
            "Model_No": "VMware",
            "SkipCR_CI_Update": true,
            "CustomFields": [
                {
                    "GroupName": "Default Group",
                    "ID": "0",
                    "Name": "HDD Name",
                    "Value": "Segate",
                    "TabName": "HDD Type"
                },
                {
                    "GroupName": "HDD TAB",
                    "ID": "0",
                    "Name": "Remarks",
                    "Value": "TestWithTab",
                    "TabName": "HDD Type"
                },
                {
                    "GroupName": "Addn Group",
                    "ID": "0",
                    "Name": "Remarks",
                    "Value": "Addtional Info attribute",
                    "TabName": "Additional Information"
                }
            ],
            "MVCustomFields": [
                {
                    "AttributeValues": [
                        {
                            "GroupName": "HDD DETAILS",
                            "ID": "0",
                            "AttributeSource": "HDD Size",
                            "Value": "250GB",
                            "TabName": "HDD Tab"
                        },
                        {
                            "GroupName": "HDD DETAILS",
                            "ID": "0",
                            "AttributeSource": "Manufacturer",
                            "Value": "Lenovo",
                            "TabName": "HDD Tab"
                        }
                    ],
                    "RowID": 1
                }
            ]
        }
    }
}

Request Parameters

Configuration_Id

INTEGER

Unique Identification number of the Configuration Item.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI.

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Location of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

SkipCR_CI_Update

BOOLEAN

Specify the value to update the CI with CR or not.

  • If the value is true, the CR will not get updated with the CI.

  • If the value is false, the CR will get updated with the CI.

FALSE

CustomFields

ARRAY

Custom Fields of the specified CI Classification.

You can specify the following values:

  • GroupName

  • ID

  • Name

  • Value

FALSE

MVCustomFields

ARRAY

Multi-valued Custom Fields of the specified CI Classification to display the various groups in multiple row.

You can specify the following values:

  • GroupName

  • ID

  • AttributeSource

  • Value

FALSE

Sample Request

{
  "Errors": "APIKey and AuthType both are mandatory.",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": null,
  "OutputID": 0,
  "Input": "Device Host Name: "
}

Sample Request

{
  "ServiceName": "CMDB_CreateOrUpdateCIDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "ProxyID": 0,
      "ReturnType": "JSON",
      "APIKey": ""
    },
    "_CMDBDetails": {
      "Configuration_Id": 0,
      "InstanceName": "",
      "Device_Host_Name": "",
      "Serial_No": "",
      "Owner_Workgroup_Name": "",
      "Owner_Name": "",
      "Managed_By": "",
      "Classification": "",
      "Status": "",
      "LifeCycleStatus": "",
      "Criticality_Name": "",
      "Customer": "",
      "Active": 0,
      "VendorName": "",
      "LocationName": "",
      "Make": "",
      "Mac_Address": "",
      "IPAddress": "",
      "Model_No": "",
      "Rack": "",
      "Warranty": "",
      "Annual_Maintains_Contract": "",
      "Version": "1.0",
      "Description": "",
      "Remarks": "",
      "Test_Plan_Mandatory": true,
      "Purchase_Order_No": "",
      "Desktop_IpAddress": "",
      "Desktop_CPU": "",
      "Desktop_Hard_Disk_Drive": "",
      "Desktop_RAM": "",
      "Desktop_NIC": "",
      "Desktop_NETWORK": "",
      "Desktop_OPERATING_SYSTEM": "",
      "Desktop_SERVICE_PACK": "",
      "Desktop_INSTALLED_APPLICATIONS": "",
      "Desktop_PATCHES": "",
      "MVCustomFields": [
        {
          "AttributeValues": [
            {
              "GroupName": "",
              "ID": "0",
              "AttributeSource": "",
              "Value": ""
            },
            {
              "GroupName": "",
              "ID": "0",
              "AttributeSource": "",
              "Value": ""
            }
          ],
          "RowID": 1
        },
        {
          "AttributeValues": [
            {
              "GroupName": "",
              "AttributeSource": "",
              "Value": ""
            },
            {
              "GroupName": "",
              "AttributeSource": "",
              "Value": ""
            }
          ],
          "RowID": 2
        }
      ]
    }
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Configuration_Id

INTEGER

Unique Identification number of the Configuration Item.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI.

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

Active

INTEGER

Indicates the status set for the CI.

  • If specified, the CI is enabled to display on the other pages of the application.

  • If not specified, the CI is inactive and is not displayed on the other pages of the application.

FALSE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Location of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

IPAddress

STRING

IP address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

Rack

STRING

Rack name to install the CI.

FALSE

Warranty

STRING

Warranty conditions for the CI.

FALSE

Annual_Maintains_Contract

STRING

Annual Maintenance Contract set for the CI.

FALSE

Version

STRING

Version details of the CI.

FALSE

Description

STRING

Description for the CI.

FALSE

Remarks

STRING

Remarks, if any.

FALSE

Test_Plan_Mandatory

BOOLEAN

Indicates the status set for testing the linked Change Record (CR).

  • If the value is true, it is mandatory to test the linked CR and have at least one successful test result before implementation.

  • If the value is false, it is not mandatory to test the linked CR.

FALSE

Purchase_Order_No

STRING

Order number of the purchase.

FALSE

Desktop_IpAddress

STRING

IP Address of the Desktop.

FALSE

Desktop_CPU

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

FALSE

Desktop_Hard_Disk_Drive

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

FALSE

Desktop_RAM

STRING

Specify the speed of RAM.

FALSE

Desktop_NIC

STRING

Details of the network card.

FALSE

Desktop_NETWORK

STRING

Details of the network that is connected to the CI.

FALSE

Desktop_OPERATING_SYSTEM

STRING

Details of the operating system that is installed on the CI.

FALSE

Desktop_SERVICE_PACK

STRING

Details of the Service packs that are installed on the CI.

FALSE

Desktop_INSTALLED_APPLICATIONS

STRING

Details of the software applications that are installed on the CI.

FALSE

Desktop_PATCHES

STRING

Details of the patches of the software application.

FALSE

MVCustomFields

ARRAY

Multi-valued Custom Fields of the specified CI Classification to display the various groups in multiple row.

You can specify the following values:

  • GroupName

  • ID

  • AttributeSource

  • Value

FALSE

Sample Request

{
  "Errors": "APIKey and AuthType both are mandatory.",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": null,
  "OutputID": 0,
  "Input": "Device Host Name: "
}

Sample Request

{
  "ServiceName": "CMDB_CreateOrUpdateCIDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "ProxyID": 0,
      "ReturnType": "JSON",
      "APIKey": ""
    },
    "_CMDBDetails": {
      "Configuration_Id": 0,
      "InstanceName": "",
      "Device_Host_Name": "",
      "Serial_No": "",
      "Owner_Workgroup_Name": "",
      "Owner_Name": "",
      "Managed_By": "",
      "Classification": "",
      "Status": "",
      "LifeCycleStatus": "",
      "Criticality_Name": "",
      "Customer": "",
      "Active": 0,
      "VendorName": "",
      "LocationName": "",
      "Make": "",
      "Mac_Address": "",
      "IPAddress": "",
      "Model_No": "",
      "Rack": "",
      "Warranty": "",
      "Annual_Maintains_Contract": "",
      "Version": "1.0",
      "Description": "",
      "Remarks": "",
      "Test_Plan_Mandatory": true,
      "Purchase_Order_No": "",
      "Desktop_IpAddress": "",
      "Desktop_CPU": "",
      "Desktop_Hard_Disk_Drive": "",
      "Desktop_RAM": "",
      "Desktop_NIC": "",
      "Desktop_NETWORK": "",
      "Desktop_OPERATING_SYSTEM": "",
      "Desktop_SERVICE_PACK": "",
      "Desktop_INSTALLED_APPLICATIONS": "",
      "Desktop_PATCHES": "",
      "CustomFields": [
        {
          "GroupName": "",
          "ID": "0",
          "Name": "",
          "Value": ""
        },
        {
          "GroupName": "",
          "ID": "0",
          "Name": "",
          "Value": ""
        }
      ]
    }
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Configuration_Id

INTEGER

Unique Identification number of the Configuration Item.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI.

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

Active

INTEGER

Indicates the status set for the CI.

  • If specified, the CI is enabled to display on the other pages of the application.

  • If not specified, the CI is inactive and is not displayed on the other pages of the application.

FALSE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Location of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

IPAddress

STRING

IP address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

Rack

STRING

Rack name to install the CI.

FALSE

Warranty

STRING

Warranty conditions for the CI.

FALSE

Annual_Maintains_Contract

STRING

Annual Maintenance Contract set for the CI.

FALSE

Version

STRING

Version details of the CI.

FALSE

Description

STRING

Description for the CI.

FALSE

Remarks

STRING

Remarks, if any.

FALSE

Test_Plan_Mandatory

BOOLEAN

Indicates the status set for testing the linked Change Record (CR).

  • If the value is true, it is mandatory to test the linked CR and have at least one successful test result before implementation.

  • If the value is false, it is not mandatory to test the linked CR.

FALSE

Purchase_Order_No

STRING

Order number of the purchase.

FALSE

Desktop_IpAddress

STRING

IP Address of the Desktop.

FALSE

Desktop_CPU

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

FALSE

Desktop_Hard_Disk_Drive

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

FALSE

Desktop_RAM

STRING

Specify the speed of RAM.

FALSE

Desktop_NIC

STRING

Details of the network card.

FALSE

Desktop_NETWORK

STRING

Details of the network that is connected to the CI.

FALSE

Desktop_OPERATING_SYSTEM

STRING

Details of the operating system that is installed on the CI.

FALSE

Desktop_SERVICE_PACK

STRING

Details of the Service packs that are installed on the CI.

FALSE

Desktop_INSTALLED_APPLICATIONS

STRING

Details of the software applications that are installed on the CI.

FALSE

Desktop_PATCHES

STRING

Details of the patches of the software application.

FALSE

CustomFields

ARRAY

Custom Fields of the specified CI Classification.

You can specify the following values:

  • GroupName

  • ID

  • Name

  • Value

FALSE

Sample Request

{
  "Errors": "APIKey and AuthType both are mandatory.",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": null,
  "OutputID": 0,
  "Input": "Device Host Name: "
}

Sample Request

{
  "ServiceName": "CMDB_CreateOrUpdateCIDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "ProxyID": 0,
      "ReturnType": "JSON",
      "APIKey": ""
    },
    "_CMDBDetails": {
      "Configuration_Id": 0,
      "InstanceName": "",
      "Device_Host_Name": "",
      "Serial_No": "",
      "Owner_Workgroup_Name": "",
      "Owner_Name": "",
      "Managed_By": "",
      "Classification": "",
      "Status": "",
      "LifeCycleStatus": "",
      "Criticality_Name": "",
      "Customer": "",
      "Active": 1,
      "VendorName": "",
      "LocationName": "",
      "Make": "",
      "Mac_Address": "",
      "IPAddress": "",
      "Model_No": "",
      "Rack": "",
      "Warranty": "",
      "Annual_Maintains_Contract": "",
      "Version": "",
      "Description": "",
      "Remarks": "",
      "Test_Plan_Mandatory": true,
      "Purchase_Order_No": "",
      "Network_IpAddress": "",
      "Network_SUBNET_MASK": "",
      "Network_GATEWAY": "",
      "Network_NO_OF_SLOTS": 0,
      "Network_SLOT_NUMBERS": "",
      "Network_PORTS": "",
      "Network_CARD_TYPE": "",
      "Network_VLAN": "",
      "Network_FLASH_MEMORY": "",
      "Network_DRAM_MEMORY": "",
      "Network_IOS_SOFTWARE": "",
      "Network_ACCESS_LIST": "",
      "Network_ROUTES": "",
      "Network_A_END_DESCRIPTION": "",
      "Network_A_END_IP_ADDRESS": "",
      "Network_B_END_DESCTIPTION": "",
      "Network_B_END_IP_ADDRESS": "",
      "Network_CIRCUIT_ID": "",
      "MVCustomFields": [
        {
          "AttributeValues": [
            {
              "GroupName": "",
              "ID": "0",
              "AttributeSource": "",
              "Value": ""
            },
            {
              "GroupName": "",
              "ID": "0",
              "AttributeSource": "",
              "Value": ""
            }
          ],
          "RowID": 1
        },
        {
          "AttributeValues": [
            {
              "GroupName": "",
              "AttributeSource": "",
              "Value": ""
            },
            {
              "GroupName": "",
              "AttributeSource": "",
              "Value": ""
            }
          ],
          "RowID": 2
        }
      ]
    }
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Configuration_Id

INTEGER

Unique Identification number of the Configuration Item.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI.

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

Active

INTEGER

Indicates the status set for the CI.

  • If specified, the CI is enabled to display on the other pages of the application.

  • If not specified, the CI is inactive and is not displayed on the other pages of the application.

FALSE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Location of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

IPAddress

STRING

IP address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

Rack

STRING

Rack name to install the CI.

FALSE

Warranty

STRING

Warranty conditions for the CI.

FALSE

Annual_Maintains_Contract

STRING

Annual Maintenance Contract set for the CI.

FALSE

Version

STRING

Version details of the CI.

FALSE

Description

STRING

Description for the CI.

FALSE

Remarks

STRING

Remarks, if any.

FALSE

Test_Plan_Mandatory

BOOLEAN

Indicates the status set for testing the linked Change Record (CR).

  • If the value is true, it is mandatory to test the linked CR and have at least one successful test result before implementation.

  • If the value is false, it is not mandatory to test the linked CR.

FALSE

Purchase_Order_No

STRING

Order number of the purchase.

FALSE

Network_IpAddress

STRING

IP Address of the Network.

FALSE

Network_SUBNET_MASK

STRING

Subnet mask to configure the CI.

FALSE

Network_GATEWAY

STRING

Specify the Gateway number.

FALSE

Network_NO_OF_SLOTS

STRING

Number of slots available in the respective card.

FALSE

Network_SLOT_NUMBERS

STRING

Slot number of the CI.

FALSE

Network_PORTS

STRING

Number of ports available in the CI.

FALSE

Network_CARD_TYPE

STRING

Type of the card.

FALSE

Network_VLAN

STRING

Specify the VLAN.

FALSE

Network_FLASH_MEMORY

STRING

Details of the FLASH memory.

FALSE

Network_DRAM_MEMORY

STRING

Details of the DRAM memory.

FALSE

Network_IOS_SOFTWARE

STRING

Specify the details, if any.

FALSE

Network_ACCESS_LIST

STRING

Details of the access, if any.

FALSE

Network_ROUTES

STRING

Details of the route, if any.

FALSE

Network_A_END_DESCRIPTION

STRING

Specify the start point details.

FALSE

Network_A_END_IP_ADDRESS

STRING

Specify the start point IP.

FALSE

Network_B_END_DESCTIPTION

STRING

Specify the end point details.

FALSE

Network_B_END_IP_ADDRESS

STRING

Specify the end point IP.

FALSE

Network_CIRCUIT_ID

STRING

Unique identification number of the circuit.

FALSE

MVCustomFields

ARRAY

Multi-valued Custom Fields of the specified CI Classification to display the various groups in multiple row.

You can specify the following values:

  • GroupName

  • ID

  • AttributeSource

  • Value

FALSE

Sample Request

Sample Request

{
  "ServiceName": "CMDB_CreateOrUpdateCIDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "_CMDBDetails": {
      "InstanceName": "IT",
      "Device_Host_Name": "Cisco Router 267",
      "Serial_No": "CiscoBLR02",
      "Owner_Workgroup_Name": "Network",
      "Owner_Name": "John@xyz.com",
      "Managed_By": "Network",
      "Classification": "Network Device\\Network",
      "Status": "Production",
      "LifeCycleStatus": "Design",
      "Criticality_Name": "Critical",
      "Customer": "Volkswagen Infotainment",
      "VendorName": "Cisco",
      "LocationName": "Bangalore",
      "Make": "Cisco",
      "Mac_Address": "AB:CD:65:45:GV",
       "IPAddress": "",
      "Model_No": "Cisco 1200",
      "Rack": "Rack1",
      "Warranty": "2018-04-30",
      "Annual_Maintains_Contract": "Contract",
      "Version": "1.0",
      "Description": "CI Created for NETWROK Devices",
      "Remarks": "CI Created for NETWROK Devices",
      "Test_Plan_Mandatory": true,
      "Purchase_Order_No": "PO123",
      "Network_IpAddress": "20.10.1.2",
      "Network_SUBNET_MASK": "255.255.255.0",
      "Network_GATEWAY": "20.10.8.154",
      "Network_NO_OF_SLOTS": "2",
      "Network_SLOT_NUMBERS": "2",
      "Network_PORTS": "20",
      "Network_CARD_TYPE": "NIC",
      "Network_VLAN": "10",
      "Network_FLASH_MEMORY": "2",
      "Network_DRAM_MEMORY": "2",
      "Network_IOS_SOFTWARE": "Cisco",
      "Network_ACCESS_LIST": "ACL",
      "Network_ROUTES": "20",
      "Network_A_END_DESCRIPTION": "NETWROK A DESCRIPTION",
      "Network_A_END_IP_ADDRESS": "Network A IP Address",
      "Network_B_END_DESCTIPTION": "NETWROK B DESCRIPTION",
      "Network_B_END_IP_ADDRESS": "Network B IP Address",
      "Network_CIRCUIT_ID": "CircuitID",
      "CustomFields": [
        {
          "GroupName": "IOS and Monitoring details",
          "ID": "0",
          "Name": "IOS Version",
          "Value": "5.6"
        },
        {
          "GroupName": "IOS and Monitoring details",
          "ID": "0",
          "Name": "Solarwinds Link",
          "Value": "http://symphonysummit.com"
        }
      ]
    }
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI.

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Location of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

IPAddress

STRING

IP address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

Rack

STRING

Rack name to install the CI.

FALSE

Warranty

STRING

Warranty conditions for the CI.

FALSE

Annual_Maintains_Contract

STRING

Annual Maintenance Contract set for the CI.

FALSE

Version

STRING

Version details of the CI.

FALSE

Description

STRING

Description for the CI.

FALSE

Remarks

STRING

Remarks, if any.

FALSE

Test_Plan_Mandatory

BOOLEAN

Indicates the status set for testing the linked Change Record (CR).

  • If the value is true, it is mandatory to test the linked CR and have at least one successful test result before implementation.

  • If the value is false, it is not mandatory to test the linked CR.

FALSE

Purchase_Order_No


Order number of the purchase.

FALSE

Network_IpAddress

STRING

IP Address of the Network.

FALSE

Network_SUBNET_MASK

STRING

Subnet mask to configure the CI.

FALSE

Network_GATEWAY

STRING

Specify the Gateway number.

FALSE

Network_NO_OF_SLOTS

STRING

Number of slots available in the respective card.

FALSE

Network_SLOT_NUMBERS

STRING

Slot number of the CI.

FALSE

Network_PORTS

STRING

Number of ports available in the CI.

FALSE

Network_CARD_TYPE

STRING

Type of the card.

FALSE

Network_VLAN

STRING

Specify the VLAN.

FALSE

Network_FLASH_MEMORY

STRING

Details of the FLASH memory.

FALSE

Network_DRAM_MEMORY

STRING

Details of the DRAM memory.

FALSE

Network_IOS_SOFTWARE

STRING

Specify the details, if any.

FALSE

Network_ACCESS_LIST

STRING

Details of the access, if any.

FALSE

Network_ROUTES

STRING

Details of the route, if any.

FALSE

Network_A_END_DESCRIPTION

STRING

Specify the start point details.

FALSE

Network_A_END_IP_ADDRESS

STRING

Specify the start point IP.

FALSE

Network_B_END_DESCTIPTION

STRING

Specify the end point details.

FALSE

Network_B_END_IP_ADDRESS

STRING

Specify the end point IP.

FALSE

Network_CIRCUIT_ID

STRING

Unique identification number of the circuit.

FALSE

CustomFields

ARRAY

Custom Fields of the specified CI Classification.

You can specify the following values:

  • GroupName

  • ID

  • Name

  • Value

FALSE

Sample Request

{
  "Errors": "",
  "Message": "",
  "OrgID": 0,
  "Output": "CI Created successfully, reference CI ID: 9631",
  "OutputObject": null,
  "TokenID": null
}

Sample Request

{
  "ServiceName": "CMDB_CreateOrUpdateCIDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "_CMDBDetails": {
      "Configuration_Id": 9630,
      "InstanceName": "IT",
      "Device_Host_Name": "Server269",
      "Serial_No": "m123-1212-cu44-4n8j",
      "Owner_Workgroup_Name": "Database",
      "Owner_Name": "John@xyz.com",
      "Managed_By": "Database",
      "Classification": "Server\\Wintel Server",
      "Status": "Production",
      "LifeCycleStatus": "Design",
      "Criticality_Name": "Critical",
      "Customer": "Volkswagen Infotainment",
      "VendorName": "IBM",
      "LocationName": "Bangalore",
      "Make": "Cisco",
      "Mac_Address": "3E:45:DT:G6",

       "IPAddress": "",
      "Model_No": "VMware",
      "Rack": "Rack1",
      "Warranty": "2018-04-30",
      "Annual_Maintains_Contract": "Contract",
      "Version": "1.0",
      "Description": "CI Created for Server",
      "Remarks": "CI Created for Server",
      "Test_Plan_Mandatory": true,
      "Purchase_Order_No": "PO123",
      "Server_IpAddress": "10.7.51.2",
      "Server_CPU": "8 Core Processor",
      "Server_Hard_Disk_Drive": "80 GB",
      "Server_RAM": "8 GB RAM",
      "Server_NIC": "2",
      "Server_NETWORK": "LAN",
      "Server_RAID_LEVEL": "1",
      "Server_RAID_CARD": "2",
      "Server_BACKUP_STATE": true,
      "Server_BACKUP_DETAILS": "Back up on secondary",
      "Server_OPERATING_SYSTEM": "Windows 2016 Standard",
      "Server_SERVICE_PACK": "SP 1",
      "Server_INSTALLED_APPLICATIONS": "Windows",
      "Server_PATCHES": "Windows",
      "MVCustomFields": [
        {
          "AttributeValues": [
            {
              "GroupName": "Patch information window.",
              "ID": "0",
              "AttributeSource": "Environment",
              "Value": "Development"
            },
            {
              "GroupName": "Patch information window.",
              "ID": "0",
              "AttributeSource": "Patching Plan",
              "Value": "Annual"
            }
          ],
          "RowID": 1
        },
        {
          "AttributeValues": [
            {
              "GroupName": "Patch information window.",
              "AttributeSource": "Environment",
              "Value": "Production"
            },
            {
              "GroupName": "Patch information window.",
              "AttributeSource": "Patching Plan",
              "Value": "Monthly"
            }
          ],
          "RowID": 2
        }
      ]
    }
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Configuration_Id

INTEGER

Unique Identification number of the Configuration Item.

FALSE

InstanceName

STRING

Name of the Instance.

For Example: Info

TRUE

Device_Host_Name

STRING

Unique name of the Device or the Host.

TRUE

Serial_No

STRING

Unique Serial number of the CI.

TRUE

Owner_Workgroup_Name

STRING

Specify the name of the person who heads the Workgroup.

TRUE

Owner_Name

STRING

Owner of the CI.

TRUE

Managed_By

STRING

Name of the Workgroup who manages the CI.

FALSE

Classification

STRING

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

  • "Server" is an example for single value in which there is no child for the parent.

TRUE

Status

STRING

Status of the CI.

TRUE

LifeCycleStatus

STRING

Life cycle status of the CI. 

TRUE

Criticality_Name

STRING

Name of the CI Criticality.

TRUE

Customer

STRING

Customer name of the CI.

TRUE

VendorName

STRING

Vendor name of the CI.

FALSE

LocationName

STRING

Lacation of the CI.

FALSE

Make

STRING

Make of the CI.

FALSE

Mac_Address

STRING

MAC address of the CI.

FALSE

IPAddress

STRING

IP address of the CI.

FALSE

Model_No

STRING

Model number of the CI.

FALSE

Rack

STRING

Rack name to install the CI.

FALSE

Warranty

STRING

Warranty conditions for the CI.

FALSE

Annual_Maintains_Contract

STRING

Annual Maintenance Contract set for the CI.

FALSE

Version

STRING

Version details of the CI.

FALSE

Description

STRING

Description for the CI.

FALSE

Remarks

STRING

Remarks, if any.

FALSE

Test_Plan_Mandatory

BOOLEAN

Indicates the status set for testing the linked Change Record (CR).

  • If the value is true, it is mandatory to test the linked CR and have at least one successful test result before implementation.

  • If the value is false, it is not mandatory to test the linked CR.

FALSE

Purchase_Order_No

STRING

Order number of the purchase.

FALSE

Server_IpAddress

STRING

IP address of the Server.

FALSE

Server_CPU

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

For Example:

  • 8 Core Processor

  • 3.5 GHz

FALSE

Server_Hard_Disk_Drive

STRING

Specify the capacity/speed, and the company name of the Hard Disk Drive.

For Example:

  • 250 GB

  • 5 GHz

FALSE

Server_RAM

STRING

Specify the size of RAM.

For Example:

  • 8 GB

FALSE

Server_NIC

STRING

Details of the network card. Specify the number of components.

FALSE

Server_NETWORK

STRING

Details of the network that is connected to the server.

For Example:

  • LAN

  • WLAN

FALSE

Server_RAID_LEVEL

STRING

Details of the RAID level.

FALSE

Server_RAID_CARD

STRING

Details of the RAID card.

FALSE

Server_BACKUP_STATE

BOOLEAN

Specify if the backup is required or not.

FALSE

Server_BACKUP_DETAILS

STRING

Specify the Backup details.

FALSE

Server_OPERATING_SYSTEM

STRING

Details of the operating system that is installed on the server.

FALSE

Server_SERVICE_PACK

STRING

Details of the Service packs that are installed on the server.

FALSE

Server_INSTALLED_APPLICATIONS

STRING

Details of the software applications that are installed on the server.

FALSE

Server_PATCHES

STRING

Details of the patches of the software application.

FALSE

MVCustomFields

ARRAY

Multi-valued Custom Fields of the specified CI Classification to display the various groups in multiple row.

You can specify the following values:

  • GroupName

  • ID

  • AttributeSource

  • Value

FALSE

Sample Request

{
  "Errors": "",
  "Message": "",
  "OrgID": 0,
  "Output": "Successfully updated CMDB Details for ID: 9630",
  "OutputObject": null,
  "TokenID": null
}

Sample Request

Request Parameters

Sample Request