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 Product name - ev itsm.png

  • 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 Logo - EasyVista.png 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 / objects

Mandatory parameters

None

Optional parameters

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

Parameter Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • Example documentation icon EN.png /requests?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • Example documentation icon EN.png /requests?sort=submit_date_ut+desc
fields string Select fields to display.
  • Example documentation icon EN.png /requests?fields=submit_date_ut,end_date_ut,requestor.last_name,recipient.e_mail
search string Search/filter specified fields.
  • Example documentation icon EN.png /requests?search=rfc_number:"I161026_000005"

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

  • Example documentation icon EN.png /requests?search=submit_date_ut:last_week

Fields that could be used in optional parameters

You can use all the JSON objects 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 Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "error": "Invalid Login / Password"
}

Examples

Result for 3 requests (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 (URL) which do not correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields; they allow the value of a database field to be assigned or modified.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method Reopen an incident/request

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

Tags:
Last modified by Unknown User on 2018/11/14 12:29
Created by Administrator XWiki on 2017/04/07 12:01

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018