REST API - View a list of news


Minimum version: Service Manager Oxygen 2.1.3.

GET  /news

  • This method allows a list of news to be obtained.
  • To obtain detailed information about a specified news: GET /news/{document_id}. Open url.png See the method.

Notes

      Open url.png  see Service Manager REST API Conventions

  • 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 provided.
    • A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained.

List of parameters / fields

Mandatory parameters

None

Optional parameters

None

Optional fields

None

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"
}

Example

Result for 3 news (status code 200)

{
   "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news?search=L_EN:1&max_rows=3",
   "record_count": "3",
   "total_record_count": "48",
   "records": [
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18805",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18805/description"
            },
           "DOCUMENT_ID": "18805",
           "DOCUMENT_NAME": "No Internet Access Friday Evening",
           "END_DATE": "",
           "FRONT_OFFICE": "1",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents/Hardware/Workstation",
           "SD_CATALOG_ID": "4702",
           "START_DATE": "2004-06-01",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        },
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18806",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18806/description"
            },
           "DOCUMENT_ID": "18806",
           "DOCUMENT_NAME": "Instant Messaging Usage Policy",
           "END_DATE": "",
           "FRONT_OFFICE": "1",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents",
           "SD_CATALOG_ID": "4699",
           "START_DATE": "2004-06-01",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        },
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18838",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18838/description"
            },
           "DOCUMENT_ID": "18838",
           "DOCUMENT_NAME": "CRM application upgrade",
           "END_DATE": "",
           "FRONT_OFFICE": "0",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents/Infrastructure",
           "SD_CATALOG_ID": "4747",
           "START_DATE": "",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        }
    ]
}


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)"  }  }

Tags:
Last modified by Unknown User on 2020/07/17 19:55
Created by Administrator XWiki on 2020/03/30 11:34

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020