REST API - View a ticket

Last modified on 2022/11/08 13:22
Contents

GET  /requests/{rfc_number}

Notes

      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

StatusHeader

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
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"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.

example

{
 "error": "Resource not found"
}

Examples

Result with a status code 200 returned

{
 "HREF": "https://{your_server}/api/v1/{your_account}/requests/S161123_000034",
 "ANALYTICAL_CHARGE_PATH": "",
 "AVAILABLE_FIELD_1": "",
 "AVAILABLE_FIELD_2": "",
 "AVAILABLE_FIELD_3": "",
 "AVAILABLE_FIELD_4": "",
 "AVAILABLE_FIELD_5": "",
 "AVAILABLE_FIELD_6": "",
 "BUDGET_EFFECTIVE": "",
 "BUDGET_ID": "",
 "BUDGET_PLANNED": "",
 "CAN_BE_DUPLICATED": "0",
 "CLICK_2_GET_INSTALL_RESULT": "",
 "COMMENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/comment/S161123_000034"
  },
 "CREATION_DATE_UT": "2016-11-23T20:19:22.117Z",
 "DELAY": "",
 "DEPARTMENT_PATH": "",
 "DESCRIPTION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/description/S161123_000034"
  },
 "DYNAMIC_DETAILS": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/dynamic_details/S161123_000034"
  },
 "EFFECTIVE_CHANGE_DATE_END": "",
 "EFFECTIVE_CHANGE_DATE_START": "",
 "END_DATE_UT": "",
 "ESTIMATED_NET_PRICE": "",
 "ESTIMATED_PERCENT_COMPLETE": "",
 "EXPECTED_DATE_UT": "",
 "EXPECTED_DURATION": "",
 "EXPECTED_END_DATE_UT": "",
 "EXPECTED_START_DATE_UT": "",
 "EXTERNAL_REFERENCE": "",
 "FIRST_CALL_RESOLUTION": "0",
 "HOUR_PER_DAY": "",
 "IMPUTATION_DATE": "",
 "INITIAL_SD_CATALOG_PATH": "",
 "IS_FINANCIAL_COMPTED": "1",
 "IS_MAJOR_INCIDENT": "",
 "IS_TEMPLATE": "0",
 "KNOWN_PROBLEMS_PATH": "",
 "LAST_UPDATE": "2016-11-23T20:19:22.200Z",
 "LOCATION_PATH": "Europe/United Kingdom",
 "MARK_1": "",
 "MARK_2": "",
 "MAX_RESOLUTION_DATE_UT": "",
 "MS_PROJECT_IMPORT_VALIDATION_WAITING": "0",
 "NET_PRICE": "0.00",
 "NOT_DEDUCED_CALL": "",
 "ORDER_NET_PRICE": "",
 "PLANNED_CHANGE_DATE_END": "",
 "PLANNED_CHANGE_DATE_START": "",
 "PROJECT_NAME": "",
 "PROJECT_START_DATE_UT": "",
 "QTY": "",
 "RENTAL_NET_PRICE": "0.00",
 "REQUALIFICATION_PROCESSING": "0",
 "REQUEST_ID": "61320",
 "REQUESTED_CHANGE_DATE_END": "",
 "REQUESTED_CHANGE_DATE_START": "",
 "REQUESTOR_FEEDBACK": "",
 "REQUESTOR_IP_ADDRESS": "176.34.179.238",
 "REQUESTOR_PHONE": "",
 "RFC_NUMBER": "S161123_000034",
 "RISK_AMOUNT": "",
 "RISK_DESCRIPTION": {
   "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",
 "TIME_USED_TO_DELIVER_FEEDBACK": "",
 "TIME_USED_TO_SOLVE_REQUEST": "",
 "VALIDATION_LEVEL_REQUIRED": "",
 "WAVE_ID_TARGET": "",
 "RECIPIENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "CELLULAR_NUMBER": " -",
   "DEPARTMENT_PATH": "",
   "E_MAIL": "argointegrationtests@easyvista.com",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
  },
 "REQUESTOR": {
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "CELLULAR_NUMBER": " -",
   "DEPARTMENT_PATH": "",
   "E_MAIL": "argointegrationtests@easyvista.com",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
  },
 "LOCATION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/locations/92",
   "CITY": "",
   "LOCATION_CODE": "",
   "LOCATION_EN": "United Kingdom",
   "LOCATION_PATH": "Europe/United Kingdom"
  },
 "DEPARTMENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/departments/5",
   "DEPARTMENT_CODE": "",
   "DEPARTMENT_EN": "-",
   "DEPARTMENT_PATH": "",
   "DEPARTMENT_LABEL": ""
  },
 "STATUS": {
   "HREF": "https://{your_server}/api/v1/{your_account}/status/12",
   "STATUS_EN": "In progress",
   "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}"
  }
}
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/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)"  }  }
Tags:
Powered by XWiki © EasyVista 2022