REST API - View a ticket

Last modified on 2022/11/08 13:22

GET  /requests/{rfc_number}


      Open url.png  See Service Manager REST API Conventions.

  • The contents of the Memo fields is not returned in the results of requests involving the main resources. To obtain the contents of these fields, you must use a specific resource which you will find in the examples below.
  • 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
rfc_number string Ticket identifier

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 /requests/S161123_000034?fields=available_field_1,comment
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/S161123_000034?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /requests/S161123_000034?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


Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

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


 "error": "Invalid Login / Password"
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.


 "error": "Resource not found"


Result with a status code 200 returned

 "HREF": "https://{your_server}/api/v1/{your_account}/requests/S161123_000034",
 "BUDGET_ID": "",
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/comment/S161123_000034"
 "CREATION_DATE_UT": "2016-11-23T20:19:22.117Z",
 "DELAY": "",
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/description/S161123_000034"
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/dynamic_details/S161123_000034"
 "END_DATE_UT": "",
 "HOUR_PER_DAY": "",
 "IS_TEMPLATE": "0",
 "LAST_UPDATE": "2016-11-23T20:19:22.200Z",
 "LOCATION_PATH": "Europe/United Kingdom",
 "MARK_1": "",
 "MARK_2": "",
 "NET_PRICE": "0.00",
 "QTY": "",
 "RENTAL_NET_PRICE": "0.00",
 "REQUEST_ID": "61320",
 "RFC_NUMBER": "S161123_000034",
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/risk_description/S161123_000034"
 "SD_CATALOG_PATH": "Service Request/Other request/(evApps test) questionnaire",
 "SUBMIT_DATE_UT": "2016-11-23T20:19:22.117Z",
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "E_MAIL": "",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "E_MAIL": "",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
   "HREF": "https://{your_server}/api/v1/{your_account}/locations/92",
   "CITY": "",
   "LOCATION_EN": "United Kingdom",
   "LOCATION_PATH": "Europe/United Kingdom"
   "HREF": "https://{your_server}/api/v1/{your_account}/departments/5",
   "DEPARTMENT_EN": "-",
 "STATUS": {
   "HREF": "https://{your_server}/api/v1/{your_account}/status/12",
   "STATUS_EN": "In progress",
   "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}"

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

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

example   Method View an asset

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/2016 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)"  }  }
Powered by XWiki © EasyVista 2022