REST API - Update a news article

Last modified on 2023/01/20 14:16
Contents

Minimum version Service Manager: Oxygen 2.1.3

PUT  /news/{document_id}

  • This method allows a specified news article to be modified.
           example /news/19001

Notes

       Open url.png  see Service Manager REST API Conventions 

  • You must supply a table in JSON format in the body of the HTTP request.
  • If successful, an HTTP status code 201 is returned and a URL link (HREF) to the updated resource is provided.
CommonNotes_JSONandFields

JSON Format / Field Format:

  • The field names are those of the Service Manager.data model.

example  available_field_1

  • To update a field, respect the following JSON format: "field_name":"value".
  • JSON object names, including those representing Service Manager database fields, are not case sensitive.

example  field_name, Field_Name and FIELD_NAME are equivalent

List of parameters / fields

Mandatory parameters

  • You must use the parameter below in the URL.
  • You must use at least one of the optional fields in the body of the HTTP request. Otherwise an error is returned.
Parameter Type Description / Example
document_id number News article identifier

Optional parameters

None

Optional fields

None

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
Status201
201 Created Request successfully processed and element created.
Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}
Status405
405 Method not allowed Unauthorized request method, i.e. it is not supported or not appropriate for the resource.

example

{
 "error": "Invalid input parameter"
}

Examples

Example of the body of an HTTP request with HTML code

{
 "DESCRIPTION": "<![CDATA[<span style=\"color: red\">EV - Service Manager</span> : update the <u>news article</u>!]]>",
 "FRONT_OFFICE": true,
 "SD_CATALOG_ID": 4702,
 "DISPLAY_LAST_UPDATE": true,
 "L_EN": true,
 "L_FR": true,
 "L_SP": true,
 "L_GE": true,
 "L_IT": true,
 "L_PO": true
}

Result with a status code 201 returned

{
   "HREF": "https://{your_server}/api/v1/{your_account}/news/19001"
}
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