Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the hideelements-macro macro with the following parameter(s): []
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

truetruetruetrue

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

Code Block
themeDJango
titleJson Format
linenumberstrue
{
  "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

Status
colourGreen
titleString

Name of the Instance. 

For Example: Info

Status
colourGreen
titletrue

OrgID

Status
colourGreen
titleString

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

Status
colourGreen
titletrue

SearchText

Status
colourGreen
titleString

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

Status
colourGreen
titletrue

Sample Response

Code Block
themeMidnight
titleJson Format
linenumberstrue
{
  "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.

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |