REST API - View a list of tickets
GET /requests
- This method allows a list of tickets to be obtained (a ticket includes incident, service request, change request, investment request, problem and event).
- To obtain detailed information about a specified ticket: GET /requests/{rfc_number}.
See the method.
Notes
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.
|
|||
sort | string | Sort in ascending or descending order.
|
|||
fields | string | Select fields to display.
|
|||
search | string | Search/filter specified fields.
A search on a Date field is also possible -
|
|||
Oxygen 2.1.2 - Build 2018.1.183.0 | search
(logical OR operator) |
string | Search/filter to several values from a same field
|
||
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.
|
||
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.
|
||
Oxygen 1.7 - Build 2018.1.131.0 | !
(equivalent to not) |
string | Exclude all results equal to a given character string.
|
||
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)
|
||
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)
|
||
Oxygen 1.7 - Build 2018.1.131.0 | formatDate | string | Format display of Date fields in the HTTP request result. ![]()
|
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" } |
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/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)" } } |