REST API - View a problem

Last modified on 2022/11/08 13:22

Contents

Notes
List of parameters / fields
HTTP status codes for the method
Example
- Result with a status code 200 returned
REST API Conventions

Minimum version Service Manager: Oxygen 1.8 - Build 2018.1.140.0

GET /problems/{rfc_number}

This method allows information about a specified problem to be obtained.
example /problems/P090330_000001

Notes

Open url.png 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
rfc_number	integer	Problem 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 /problems/P090330_000001?fields=submit_date_ut
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. example /problems/P090330_000001?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018" /problems/P090330_000001?fields=last_update&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"
}

Example

Result with a status code 200 returned

{
   "ANALYTICAL_CHARGE_PATH": "",
   "ANALYTICAL_CHARGE_ID": "",
   "ASSET_ID": "",
   "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": "",
   "CI_ID": "",
   "CLICK_2_GET_INSTALL_RESULT": "",
   "COMMENT": {
       "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}/comment"
    },
   "CONTINUITY_PLAN_ID": "",
   "COST_CENTER_ID": "",
   "CREATION_DATE_UT": "2009-03-30T14:11:06.000+02:00",
   "DELAY": "0",
   "DEPARTMENT_PATH": "Finance",
   "DEPARTMENT_ID": "10",
   "DESCRIPTION": {
       "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}/description"
    },
   "DYNAMIC_DETAILS": {
       "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}/dynamic_details"
    },
   "E_COST": "978,00",
   "E_DELAY": "2 694,00",
   "E_SENTIMENT_ANALYSIS": "",
   "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": "",
   "IMPACT_ID": "2",
   "IMPUTATION_DATE": "",
   "INITIAL_SD_CATALOG_PATH": "",
   "INITIAL_SD_CATALOG_ID": "",
   "IS_FINANCIAL_COMPTED": "1",
   "IS_MAJOR_INCIDENT": "",
   "IS_TEMPLATE": "",
   "KBASE_ID": "",
   "KNOWN_PROBLEMS_PATH": "",
   "KNOWN_PROBLEMS_ID": "",
   "LAST_DONE_BY_ID": "18280",
   "LAST_GROUP_ID": "",
   "LAST_UPDATE": "2017-03-24T17:54:46.923+01:00",
   "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
   "LOCATION_ID": "2230",
   "MARK_1": "",
   "MARK_2": "",
   "MAX_RESOLUTION_DATE_UT": "",
   "MS_PROJECT_IMPORT_VALIDATION_WAITING": "",
   "NET_PRICE": "",
   "NET_PRICE_CUR_ID": "",
   "NEWS_ID": "",
   "NOT_DEDUCED_CALL": "",
   "ORDER_ID": "",
   "ORDER_NET_PRICE": "",
   "ORIGIN_TOOL_ID": "",
   "OWNER_ID": "18280",
   "OWNING_GROUP_ID": "168",
   "PARENT_REQUEST_ID": "",
   "PLANNED_CHANGE_DATE_END": "",
   "PLANNED_CHANGE_DATE_START": "",
   "PM_STATUS_ID": "",
   "PROJECT_ID": "",
   "PROJECT_NAME": "",
   "PROJECT_START_DATE_UT": "",
   "QTY": "",
   "RECIPIENT_ID": "18302",
   "RELEASE_ID": "",
   "RENTAL_NET_PRICE": "",
   "RENTAL_NET_PRICE_CUR_ID": "",
   "REQUALIFICATION_PROCESSING": "0",
   "REQUEST_ID": "25989",
   "REQUEST_ORIGIN_ID": "",
   "REQUEST_PROJECT_ID": "",
   "REQUESTED_CHANGE_DATE_END": "",
   "REQUESTED_CHANGE_DATE_START": "",
   "REQUESTOR_FEEDBACK": "",
   "REQUESTOR_ID": "",
   "REQUESTOR_IP_ADDRESS": "",
   "REQUESTOR_PHONE": "",
   "REQUIRED_DOWNTIME": "",
   "RFC_NUMBER": "P090330_000001",
   "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}",
   "RISK_AMOUNT": "",
   "RISK_DESCRIPTION": {
       "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}/risk_description"
    },
   "RISK_LEVEL_ID": "",
   "ROOT_CAUSE_ID": "",
   "SD_CATALOG_PATH": "Problème/Application*",
   "SD_CATALOG_ID": "4930",
   "SEVERITY_ID": "41",
   "SLA_ID": "",
   "STATUS_ID": "12",
   "SUBMIT_DATE_UT": "2009-03-30T14:11:06.000+02:00",
   "SUBMITTED_BY": "18280",
   "SYSTEM_AFFECTED": {
       "HREF": "http://{your_server}/api/v1/{your_account}/problems/{rfc_number}/system_affected"
    },
   "SYSTEM_ID": "",
   "TIME_USED_TO_DELIVER_FEEDBACK": "",
   "TIME_USED_TO_SOLVE_REQUEST": "0",
   "TITLE": "",
   "URGENCY_ID": "2",
   "VALIDATION_LEVEL_REQUIRED": "",
   "WAVE_ID_TARGET": "",
   "CATALOG_REQUEST": {
       "CODE": "",
       "CATALOG_REQUEST_PATH": "Problème/Application*",
       "SD_CATALOG_ID": "4930",
       "TITLE_FR": "Application*"
    },
   "STATUS": {
       "STATUS_FR": "En cours",
       "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
       "STATUS_ID": "12"
    },
   "RECIPIENT": {
       "BEGIN_OF_CONTRACT": "",
       "CELLULAR_NUMBER": "",
       "DEPARTMENT_PATH": "Ventes/International France",
       "E_MAIL": "fuser@evtry.com",
       "HREF": "http://{your_server}/api/v1/{your_account}/employees/18302",
       "EMPLOYEE_ID": "18302",
       "LAST_NAME": "Jennifer",
       "LOCATION_PATH": "Europe/France/Paris",
       "PHONE_NUMBER": "+33155859645"
    },
   "REQUESTOR": {
       "BEGIN_OF_CONTRACT": "",
       "CELLULAR_NUMBER": "",
       "DEPARTMENT_PATH": "",
       "E_MAIL": "",
       "EMPLOYEE_ID": "",
       "LAST_NAME": "",
       "LOCATION_PATH": "",
       "PHONE_NUMBER": ""
    },
   "LOCATION": {
       "CITY": "",
       "LOCATION_CODE": "",
       "LOCATION_FR": "1733",
       "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
       "LOCATION_ID": "2230"
    },
   "DEPARTMENT": {
       "DEPARTMENT_CODE": "",
       "DEPARTMENT_FR": "Finance",
       "DEPARTMENT_PATH": "Finance",
       "DEPARTMENT_ID": "10",
       "DEPARTMENT_LABEL": ""
    }
}

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", } }
Green		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: