REST API - View a list of news articles

Last modified on 2023/02/21 11:18
Contents

Minimum version Service Manager: Oxygen 2.1.3

GET  /news

  • To obtain detailed information for a specified news article: 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

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.
  • Default value: 100
  • example /news?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /news?sort=document_id+desc
fields string Select fields to display.
  • example /news?fields=document_id
search string Search/filter the specified fields.   -   Open url.png See Description of the options.
  • example /news?search=document_id:"3"
Oxygen 2.1.2 - Build 2018.1.183.0 search

(logical OR operator)

 string Search/filter to several values from a same field
  • Syntax: search=field:value1,field:value2
  • example
    • /news?search=document_id:1,document_id:2 ==> all the news articles in which the document_id field is equal to 1 or 2
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.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >
    • *< string >* = include what contains < string >
  • example
    • /news?search=document_name~"internet*" ==> all news articles in which the document_name field begins with internet
    • /news?search=document_name~"*internet*" ==> all news articles in which the document_name field contains internet
Oxygen 1.7 - Build 2018.1.131.0 !~

(equivalent to not like)

 string Exclude all results equal to a given character string.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >
    • *< string >* = exclude what contains < string >
  • example
    • /news?search=document_name!~"internet*" ==> all news articles by excluding those in which the document_name field begins with internet
    • /news?search=document_name!~"internet*" ==> all news articles by excluding those in which the document_name field contains internet
Oxygen 1.7 - Build 2018.1.131.0 !

(equivalent to not)

 string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • example /news?search=document_name!"internet" ==> all news articles by excluding those in which the document_name field is equal to internet
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)
  • Syntax: Field name following by "is_null"
  • example
    • /news?search=request_id:"is_null"&sort=request_id+asc ==> all news articles in which the request_id field has no value, sorted in ascending identifier
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)
  • Syntax: Field name following by "is_not_null"
  • example
    • /news?search=request_id:"is_not_null"&sort=request_id+asc ==> all news articles in which the request_id field has a value, sorted in ascending identifier
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Specification of the date.   -   Open url.png See Description of the options.
  • example
    • /news?fields=end_date&formatDate=l/M/Y ==> "end_date_format": "Friday/Nov/2018"
    • /news?fields=end_date&formatDate=l jS \of F Y h:i:s A ==> "end_date_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 AM_DOCUMENT table.

HTTP status codes for the method

StatusHeader

   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 (Successful) Request successfully processed.
Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}

Example

Result for 3 news articles (status code 200)

{
   "HREF": "https://{your_server}/api/v1/{your_account}/news?search=L_EN:1&max_rows=3",
   "record_count": "3",
   "total_record_count": "48",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/news/18805",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/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://{your_server}/api/v1/{your_account}/news/18806",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/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://{your_server}/api/v1/{your_account}/news/18838",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/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/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)"  }  }
Tags:
Powered by XWiki © EasyVista 2022