- Welcome to the EasyVista Wiki
- Integrations
- Service Manager REST API
- REST API - View a SLA
REST API - View a SLA
Contents
GET /slas/{sla_id}
- This method allows information about a specified SLA to be obtained.
example /slas/2
Notes
See Service Manager REST API Conventions
- 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 |
|---|---|---|
| sla_id | integer | SLA 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.
|
|||
| Oxygen 1.7 - Build 2018.1.131.0 | formatDate | string | Format display of Date fields in the HTTP request result. See Description of the options.
|
Fields that could be used in optional parameters
You can use all the fields from the SD_SLA 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" } |
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" } |
Example
Result with a status code 200 returned
{
"HREF": "http://{your_server}/api/v1/{your_account}/slas/2",
"DELAY": "24,00",
"HOLIDAY_LIST_ID": "1",
"NAME_EN": "3 days",
"NAME_FR": "3 jours ouvrés",
"NAME_GE": "3 Arbeitstage",
"NAME_IT": "3 giorni lavorativi",
"NAME_L1": "",
"NAME_L2": "",
"NAME_L3": "",
"NAME_L4": "",
"NAME_L5": "",
"NAME_L6": "",
"NAME_PO": "3 dias úteis",
"NAME_SP": "3 días hábiles",
"NEXT_BUSINESS_DAY": "",
"SLA_GUID": "{AA88B3EE-412E-4121-B36B-58CA09CCFD3B}",
"SLA_ID": "2",
"TIME_LIMIT": "",
"TIME_TARGET": "",
"WORKING_HOURS_ID": "1"
}
"HREF": "http://{your_server}/api/v1/{your_account}/slas/2",
"DELAY": "24,00",
"HOLIDAY_LIST_ID": "1",
"NAME_EN": "3 days",
"NAME_FR": "3 jours ouvrés",
"NAME_GE": "3 Arbeitstage",
"NAME_IT": "3 giorni lavorativi",
"NAME_L1": "",
"NAME_L2": "",
"NAME_L3": "",
"NAME_L4": "",
"NAME_L5": "",
"NAME_L6": "",
"NAME_PO": "3 dias úteis",
"NAME_SP": "3 días hábiles",
"NEXT_BUSINESS_DAY": "",
"SLA_GUID": "{AA88B3EE-412E-4121-B36B-58CA09CCFD3B}",
"SLA_ID": "2",
"TIME_LIMIT": "",
"TIME_TARGET": "",
"WORKING_HOURS_ID": "1"
}
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)" } } |
||