Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

You can retrieve suggestions of a Symptom using the following API Request with the entered the value for the SearchText parameter. 

To authenticate the below API, see API Authentication and Authorization.

Service NameHTTP Method
IM_SuggestSimilarSymptoms

POST

Sample Request

Json Format
{
  "ServiceName": "IM_SuggestSimilarSymptoms",
  "objCommonParameters": {
    "_ProxyDetails": {
      "APIKey": "XXXXXXXXXXXXXXXX",
      "ProxyID": 0,
      "ReturnType": "JSON",
      "AuthType": "APIKEY"
    },
    "Instance": "IT Tec",
    "OrgID": "1",
    "SearchText": "test"
  }
}

Request Parameters

Parameter NameTypeDescriptionMandatory

Instance

STRING

Name of the Instance. 

For Example: Info

TRUE

OrgID

STRING

Unique Identification number of an Organization. By default, the value is 1.

TRUE

SearchText

STRING

Name of the Keyword to retrieve the suggestions of a Symptom.

TRUE

Sample Response

Json Format
{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": {
    "SymptomSuggestions": {
      "Symptoms": [
        {
          "UID": 0,
          "Symptom": "Symptom: testing rule functionality for In-Progress state",
          "BaseUrl": null,
          "TemplateID": 1,
          "OrgID": 0,
          "UserID": 0,
          "LocationID": 0,
          "Instance": null,
          "CustomerMatrixID": 0,
          "Type": null,
          "IsEditable": false
        }
      ],
      "KBData": [
        {
          "Original_FileName": null,
          "Renamed_FileName": null,
          "Image_Uid": null,
          "KB_ID": 1035,
          "KB_Subject": "all location test",
          "Active": true,
          "KB_Details": "",
          "KeyMatches": 1
        }
      ]
    }
  }
}

Status and Error Codes

For more information, see Status and Error Messages.

  • No labels