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.

Retrieve CMDB Master Methods

Prev Next

You can retrieve the CMDB master methods using the Instance name. Use the following API Request to retrieve the master method of the CMDB.

Service Name

HTTP Method

GetVendorMasterList

POST

CMDB_GetLocationMasterList

CMDB_GetCriticalityMasterList

CMDB_GetMakeMasterList

CMDB_GetCustomerMasterList

CMDB_GetClassificationMasterList

Sample Request

Below are the sample requests to retrieve different master methods of the CMDB.

Sample Request

{
  "ServiceName": "CMDB_GetClassificationMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "strInstance": "IT",
    "intParentClassificationID": 0,
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": "1A31A88ECE6DB0ECA2F6BE958CE3E35458DD3463601F1D6BE72871950B5E7CD5FB0B9747779B6D
417792A50BA0AF36E80123CE745B8654428CB1EE9E7FB48FC100327884E59D69364914877DF886AAEB6EEB2AFA361
2B0B9FCE9425650925C2CF8C93BD3BE0174F151D17F40F12A1DF710267F6E42D09FA89DEC55ECE6724CB4328F79C9
3CF60694539617DCF077186D92EC77F27E831A5C210DFDCF1A4EB1B7A403072D",
  "OrgID": 0,
  "OutputObject": {
    "ROOT": {
      "SUBROOT": [
        {
          "Active": "false",
          "Classification": "Desktop",
          "Classification_Id": "1",
          "Org_Id": "1",
          "Parent_Classification_Id": "-1",
          "Root_Classification": "Desktop",
          "Sup_Function": "IT"
        },
        {
          "Active": "true",
          "Classification": "Server",
          "Classification_Id": "2",
          "Org_Id": "1",
          "Parent_Classification_Id": "-1",
          "Root_Classification": "Server",
          "Sup_Function": "IT"
        }
      ]
    }
  },
  "OutputID": 0,
  "Input": null
}

Sample Request

{
  "ServiceName": " CMDB_GetCustomerMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "Instance": "IT",
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": "197C8EADE398E729BC235AAB858C198CC8EFA0EB187E69DD2740468EF6BBFB7742BAF47B309852916DC5B66CEFFE
62F83709DC102574A54395ABEB8417FDD2DFEC96122487E6AFBFAFFA38431613075E20FD49EB4037ABEDFC9AC5330EC34B85761AF5
342C0465613C86DE18EE69909307A3F6D1FBD61B9025FB0F719838FE1BE4FA02BFB09AFF7C24BD33D34872A103D6206CCA19B6623
DD77BBF7677449DDB311A6F84",
  "OrgID": 0,
  "OutputObject": [
    {
      "CM_ID": 4571,
      "Parent_ID": 0,
      "CM_Type": "Customer",
      "CM_Value": "-",
      "CM_Sort": 0,
      "CM_ValueInt": null,
      "CM_ValueStr": null,
      "SystemVal": false,
      "Active": true,
      "Org_Id": 2,
      "TimezoneID": null,
      "AvM_Loc_LID": null,
      "CM_AdditionalValue": "",
      "Domain_ID": 1
    },
    {
      "CM_ID": 11547,
      "Parent_ID": 0,
      "CM_Type": "Customer",
      "CM_Value": "Zedi Inc",
      "CM_Sort": 0,
      "CM_ValueInt": null,
      "CM_ValueStr": null,
      "SystemVal": false,
      "Active": true,
      "Org_Id": 2,
      "TimezoneID": null,
      "AvM_Loc_LID": null,
      "CM_AdditionalValue": "",
      "Domain_ID": 1
    }
  ],
  "OutputID": 0,
  "Input": null
}

Sample Request

{
  "ServiceName": "CMDB_GetMakeMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "Instance": "IT",
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": {
    "ROOT": {
      "SUBROOT": [
        {
          "Active": "true",
          "Make": "Assembled",
          "Make_Id": "1",
          "Org_Id": "1",
          "Sort_Order": "0",
          "Sup_Function": "IT"
        },
        {
          "Active": "true",
          "Make": "ProLiant DL360 G4",
          "Make_Id": "33",
          "Org_Id": "1",
          "Sort_Order": "1",
          "Sup_Function": "IT"
        }
      ]
    }
  },
  "OutputID": 0,
  "Input": null
}

Sample Request

{
  "ServiceName": "CMDB_GetCriticalityMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "Instance": "IT",
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": {
    "ROOT": {
      "SUBROOT": [
        {
          "Active": "true",
          "Criticality": "Critical",
          "Criticality_Id": "4",
          "Org_Id": "1",
          "Sort_Order": "0",
          "Sup_Function": "IT"
        },
        {
          "Active": "true",
          "Criticality": "High",
          "Criticality_Id": "1",
          "Org_Id": "1",
          "Sort_Order": "1",
          "Sup_Function": "IT"
        }
      ]
    }
  },
  "OutputID": 0,
  "Input": null
}

Sample Request

{
  "ServiceName": "CMDB_GetLocationMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "Instance": "IT",
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": "234E40D0CAE161C77D7C8DD941349C4A19209C0930A6908B2ABBF62D64350AA659C77565B27DE351AA46B5770404
CD003C5DDE33042B847AC8E49ED477A18F7B650A4DCEEA9E187E2197BAAC102907EEAF16DB49D1D9DD43D17AFF1DA65998F6C49A29
564BCA15CF157A546963107F3636931DE7E6C217BA5BC7F53E9D494C7564CDFEFC7EE35DA30A97D70653A0753F279429A031212682
AD489CE33ABEFD8884B01886",
  "OrgID": 0,
  "OutputObject": [
    {
      "CM_ID": 20517,
      "CM_Value": "USCH - Cheney",
      "Value": 20517,
      "Text": "USCH - Cheney"
    },
    {
      "CM_ID": 20526,
      "CM_Value": "USCW - Novi",
      "Value": 20526,
      "Text": "USCW - Novi"
    }
  ],
  "OutputID": 0,
  "Input": null
}

Sample Request

{
  "ServiceName": "CMDB_GetVendorMasterList",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "Instance": "IT",
    "blnIncDeActive": true
  }
}

Request Parameters

Parameter Name

Type

Description

Mandatory

Instance

STRING

Name of the Instance.

For Example: Info

TRUE

blnIncDeActive

BOOLEAN

Specify the Boolean value either true or false to retrieve the records.

Based on the following values the records are retrieved:

  • true, by default the value is true and retrieves both the active and inactive records.

  • false, if the value is false, only the active records are retrieved.

TRUE

Sample Request

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": {
    "ROOT": {
      "SUBROOT": [
        {
          "Active": "true",
          "Make": "Assembled",
          "Make_Id": "1",
          "Org_Id": "1",
          "Sort_Order": "0",
          "Sup_Function": "IT"
        },
        {
          "Active": "true",
          "Make": "Cisco",
          "Make_Id": "2",
          "Org_Id": "1",
          "Sort_Order": "0",
          "Sup_Function": "IT"
        }
      ]
    }
  },
  "OutputID": 0,
  "Input": null
}