REST API - View a known error


Minimum version: Service Manager Oxygen 1.8 - Build 2018.1.140.0.

GET  /knownerrors/{known_problems_id}

  • This method allows information about a specified known error to be obtained.
           example   /knownerrors/3

Notes

      Open url.png  See Service Manager REST API Conventions

  • If successful, an HTTP status code 200 is returned.
    • A URL link (HREF) to the resource is provided.
    • All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for EasyVista.
       

List of parameters / fields

Mandatory parameters

You must use the parameter below in the URL.
 

Parameter Type Description / Example
known_problems_id integer Known error dentifier

Optional parameters

You can use the parameters detailed below in the HTTP request string.
 

Minimum version Parameter Type Description / Example
fields string Select fields to display.
  • example /knownerrors/3?fields=href
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Format display of Date fields in the HTTP request result.   Open url.png See Description of the options.
  • example
    • /knownerrors/3?fields=end_date&formatDate=l/M/Y ==> "end_date_format": "Friday/Nov/2018"
    • /knownerrors/3?fields=end_date&formatDate=l jS \of F Y h:i:s A ==> "end_date_format": "Friday 16th of November 2018 12:00:00 AM"

Fields that could be used in optional parameters

You can use all the fields from the SD_KNOWN_PROBLEMS table.

HTTP status codes for the method

StatusHeader
Code Error Description
Status200
200 OK (Success) Request processed successfully.
Status401
401 Unauthorized Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}

Example

Result with a status code 200 returned

{
   "ANSWER_EN": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_en"
    },
   "ANSWER_FR": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_fr"
    },
   "ANSWER_GE": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_ge"
    },
   "ANSWER_IT": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_it"
    },
   "ANSWER_L1": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l1"
    },
   "ANSWER_L2": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l2"
    },
   "ANSWER_L3": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l3"
    },
   "ANSWER_L4": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l4"
    },
   "ANSWER_L5": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l5"
    },
   "ANSWER_L6": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_l6"
    },
   "ANSWER_PO": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_po"
    },
   "ANSWER_SP": {
       "HREF": "http://{your_server}/api/v1/{your_account}/known_problems/3/answer_sp"
    },
   "AVAILABLE_FIELD_1": "",
   "AVAILABLE_FIELD_2": "",
   "AVAILABLE_FIELD_3": "",
   "AVAILABLE_FIELD_4": "",
   "AVAILABLE_FIELD_5": "",
   "AVAILABLE_FIELD_6": "",
   "CREATION_DATE": "2003-12-19",
   "END_DATE": "",
   "EXPECTED_RESOLUTION_DATE": "",
   "IMPLEMENTATION_TIME": "",
   "KNOWN_PROBLEM_PATH": "Résolution des problèmes de moniteur*/Je ne peux pas définir la résolution au delà de 640 x 480 en 16 couleurs.",
   "KNOWN_PROBLEMS_ID": "3",
   "HREF": "http://{your_server}/api/v1/{your_account}/known-problems/3",
   "KP_NUMBER": "KB 3",
   "LAST_UPDATE": "2013-04-24",
   "LAST_UPDATE_UT": "2013-04-24T16:51:27.440+02:00",
   "QUESTION_EN": "Screen resolution can not be set beyond 640 x 480 ",
   "QUESTION_FR": "Je ne peux pas définir la résolution au delà de 640 x 480 en 16 couleurs. ",
   "QUESTION_GE": "Bildschirmauflösung kann nicht über 640 x 480 hinaus eingestellt werden ",
   "QUESTION_IT": "Non posso definire la risoluzione oltre 640 x 480 a 16 colori",
   "QUESTION_L1": "",
   "QUESTION_L2": "",
   "QUESTION_L3": "",
   "QUESTION_L4": "",
   "QUESTION_L5": "",
   "QUESTION_L6": "",
   "QUESTION_PO": "Resolução do ecran não pode ser definido para além de 640 x 480",
   "QUESTION_SP": "No puedo definir la resolución de la pantalla más de 640 x 480 en 16 colores.",
   "REVISION_DATE": "",
   "REVISION_DATE_UT": "",
   "VERSION": ""
}


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string which do not correspond to Service Manager database fields.

example   Method View a list of assets


https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag

Black and Bold Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.

example   Method View an asset


https://{your_server}/api/v1/{your_account}/assets/{asset_id}

Green Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.

example   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2019 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.

example   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }

Tags:
Last modified by Unknown User on 2020/07/17 19:55
Created by Administrator XWiki on 2019/05/16 09:18

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021