REST API - View a list of problems


Minimum version: Service Manager Oxygen 1.8 - Build 2018.1.140.0.

GET  /problems

  • This method allows a list of problems to be obtained.
  • To obtain detailed information about a specified problem: GET /problems/{rfc_number}. Open url.png See the method.

Notes

      Open url.png  See Service Manager REST API Conventions

  • If successful, an HTTP status code 200 is returned.
    • By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by EasyVista  is displayed for each record provided.
    • A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained.
       

List of parameters / fields

Mandatory parameters

None

Optional parameters

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

Minimum version Parameter Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • example /problems?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /problems?sort=rfc_number+desc
fields string Select fields to display.
  • example /problems?fields=rfc_number
search string Search/filter the specified fields.   -   Open url.png See Description of the options.
  • example /problems?search=rfc_number:"P090330_000001"

A search on a Date field is also possible.

  • example /problems?search=submit_date_ut:last_week
Oxygen 2.1.2 - Build 2018.1.183.0 search

(logical OR operator)

string Search/filter to several values from a same field
  • Syntax: search=field:value1,field:value2
  • example
    • /problems?search=rfc_number:P090330_000003,rfc_number:P090330_000004 ==> all the problems in which the rfc_number field is equal to P090330_000003 or P090330_000004
Oxygène 1.7 - Build 2018.1.131.0 ~

(equivalent to like)

string Include the results which begin with or contain a given character string.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >
    • *< string >* = include what contains < string >
  • example
    • /problems?search=catalog_request.title_en~"app*" ==> all the problems in which the catalog_request.title_en field begins with app
    • /problems?search=catalog_request.title_en~"*app*" ==> all the problems in which the catalog_request.title_en field contains app
Oxygen 1.7 - Build 2018.1.131.0 !~

(equivalent to not like)

string Exclude all results equal to a given character string.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >
    • *< string >* = exclude what contains < string >
  • example
    • /problems?search=catalog_request.title_en!~"app*" ==> all the problems by excluding those in which the catalog_request.title_en field begins with app
    • /problems?search=catalog_request.title_en!~"app*" ==> all the problems by excluding those in which the catalog_request.title_en field contains app
Oxygen 1.7 - Build 2018.1.131.0 !

(equivalent to not)

string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • example /problems?search=catalog_request.title_en!"application" ==> all the problems by excluding those in which the catalog_request.title_en field is equal to application
Oxygen 2.1.2 - Build 2018.1.183.0 is_null string Retrieve all results in which the field has no value (field value = null)
  • Syntax: Field name following by "is_null"
  • example
    • /problems?search=description:"is_null" ==> all the problems in which the description has no value
Oxygen 2.1.2 - Build 2018.1.183.0 is_not_null string Retrieve all results in which the field has a value (field value = not null)
  • Syntax: Field name following by "is_not_null"
  • example
    • /problems?search=description:"is_not_null" ==> all the problems in which the description has a value
Oxygen 2.1.2 - Build 2018.1.183.0 formatDate string Specification of the date   -   Open url.png See Description of the options.
  • example
    • /problems?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /problems?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_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_REQUEST 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"
}

Examples

Result for 3 problems (status code 200)

{
   "record_count": "3",
   "total_record_count": "7",
   "records": [
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000001/comment"
            },
           "REQUEST_ID": "25989",
           "RFC_NUMBER": "P090330_000001",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000001",
           "SUBMIT_DATE_UT": "2009-03-30T14:11:06.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Application*",
               "SD_CATALOG_ID": "4930",
               "TITLE_FR": "Application*"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Ventes/International France",
               "E_MAIL": "fuser@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18302",
               "EMPLOYEE_ID": "18302",
               "LAST_NAME": "Jennifer",
               "LOCATION_PATH": "Europe/France/Paris",
               "PHONE_NUMBER": "+33155859645"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1733",
               "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
               "LOCATION_ID": "2230"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000002/comment"
            },
           "REQUEST_ID": "25990",
           "RFC_NUMBER": "P090330_000002",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000002",
           "SUBMIT_DATE_UT": "2009-03-30T14:13:10.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Bureautique",
               "SD_CATALOG_ID": "4928",
               "TITLE_FR": "Bureautique"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Ventes/International France",
               "E_MAIL": "fuser@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18302",
               "EMPLOYEE_ID": "18302",
               "LAST_NAME": "Jennifer",
               "LOCATION_PATH": "Europe/France/Paris",
               "PHONE_NUMBER": "+33155859645"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1733",
               "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
               "LOCATION_ID": "2230"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P180903_000001/comment"
            },
           "REQUEST_ID": "42732",
           "RFC_NUMBER": "P180903_000001",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P180903_000001",
           "SUBMIT_DATE_UT": "2018-09-03T10:37:12.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Infrastructure",
               "SD_CATALOG_ID": "4929",
               "TITLE_FR": "Infrastructure"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Finance",
               "E_MAIL": "fadmin@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18368",
               "EMPLOYEE_ID": "18368",
               "LAST_NAME": "Eddy",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "PHONE_NUMBER": "+41798248341"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Finance",
               "E_MAIL": "fadmin@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18368",
               "EMPLOYEE_ID": "18368",
               "LAST_NAME": "Eddy",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "PHONE_NUMBER": "+41798248341"
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "120",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "LOCATION_ID": "1539"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
    ],
   "HREF": "http://{your_server}/api/v1/{your_account}/problems/"
}


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 2021/02/05 16:53
Created by Administrator XWiki on 2019/05/16 09:17

Shortcuts

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

Powered by XWiki ©, EasyVista 2021