REST API - View a list of tickets


GET  /requests

  • To obtain detailed information about a specified ticket: GET /requests/{rfc_number}.  Open url.png See the method.

Notes

      Open url.png  See REST API Conventions Service Manager

  • 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 supplied.
    • The rfc_number is always provided.
    • A URL link (HREF) to each resource is supplied so that the complete list of fields for a record can be obtained if required.
       

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 /requests?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /requests?sort=submit_date_ut+desc
fields string Select fields to display.
  • example /requests?fields=submit_date_ut,end_date_ut,requestor.last_name,recipient.e_mail
search string Search/filter specified fields.
  • example /requests?search=rfc_number:"I161026_000005"

A search on a Date field is also possible - Open url.png see Description of the options.

  • example /requests?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
    • /requests?search=severity_id:1,severity_id:2 ==> all the tickets in which the severity_id field is equal to 1 or 2
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
    • /requests?search=rfc_number~"000*" ==> tous les tickets dont le champ rfc_number commence par 000
    • /requests?search=rfc_number~"*000*" ==> tous les tickets dont le champ rfc_number contient 000
    • /requests?search=catalog_request.title_en~"Exod*" ==> tous les tickets dont le champ catalog_request.title commence par Exod
    • /requests?search=catalog_request.title_en~"*xod*" ==> tous les tickets dont le champ catalog_request.title contient xod
Oxygen 1.7 - Build 2018.1.131.0 !~

(equivalent to not like)

string Exclude the results which begin with or contain 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
    • /requests?search=rfc_number!~"000*" ==> all the tickets by excluding those in which the rfc_number field begins with 000
    • /requests?search=rfc_number!~"*000*" ==> all the tickets by excluding those in which the rfc_number field contains 000
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 /requests?search=rfc_number!"000002" ==> all the tickets by excluding those in which the rfc_number field is equal to 000002
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
    • /requests?search=end_date_ut:"is_null"&sort=request_id+asc ==> all the tickets in which the end date has no value, sorted in ascending identifier
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
    • /requests?search=end_date_ut:"is_null"&sort=request_id+asc ==> all the tickets in which the end date has a value, sorted in ascending identifier
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
    • /requests?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /requests?fields=last_updatet&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 tickets (status code 200)

{
 "HREF": "https://{your_server}/api/v1/{your_account}/requests?max_rows=3&fields=submit_date_ut,requestor.last_name",
   "record_count": "3",
   "total_record_count": "1191",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/requests/000002",
           "RFC_NUMBER": "000002",
           "SUBMIT_DATE_UT": "2011-11-18T01:00:00.000+01:00",
           "REQUESTOR": {
               "HREF": "https://{your_server}/api/v1/{your_account}/employees/10334",
               "EMPLOYEE_ID": "10334",
               "LAST_NAME": "Buxtehude, Andrew"
            }
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/requests/000007",
           "RFC_NUMBER": "000007",
           "SUBMIT_DATE_UT": "2011-11-19T01:00:00.000+01:00",
           "REQUESTOR": {
               "HREF": "https://{your_server}/api/v1/{your_account}/employees/10412",
               "EMPLOYEE_ID": "10412",
               "LAST_NAME": "Haring, Andrew"
            }
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/requests/000030",
           "RFC_NUMBER": "000030",
           "SUBMIT_DATE_UT": "2012-03-13T01:00:00.000+01:00",
           "REQUESTOR": {
               "HREF": "https://{your_server}/api/v1/{your_account}/employees/10409",
               "EMPLOYEE_ID": "10409",
               "LAST_NAME": "Haller, Xavier"
            }
        }
    ]
}


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 15:48
Created by Administrator XWiki on 2017/04/07 12:01

Shortcuts

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

Powered by XWiki ©, EasyVista 2021