Update

put

/km/api/v1/incidents/{id}

This method updates the Incident object with the specified ID parameter.

You must provide payload of an Incident object in FULL mode to update the object.

The only value that you can update is the description of the incident.

When you update an Incident object, in addition to the date added and date modified, you must also specify parameters such as recordId and the incidentId.

Request

Supported Media Types
Path Parameters
  • The unique identifier of the object to be updated.
Body ()
The object to be updated.
Root Schema : Incident
Match All
Show Source
Nested Schema : IncidentKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : IncidentKey-allOf[1]
Type: object
Show Source
Nested Schema : Incident-allOf[1]
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Incident
Match All
Show Source
Nested Schema : IncidentKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : IncidentKey-allOf[1]
Type: object
Show Source
Nested Schema : Incident-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to update the Incident object with the specified ID parameter by submitting a put request on the REST resource using cURL.

cURL Command

curl -X "PUT" "http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "dateAdded" : "2013-11-05T13:48:51EST",
  "dateModified" : "2013-11-05T13:48:51EST",
  "description" : "There is a problem identifying the meaning of key words for Oracle Knowledge",
  "recordId" : "2LKAJDFO8234OIJ3O24P18439837409819",
  "incidentId" : "140005-14895892",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "dateAdded" : "2013-11-05T13:48:51EST",
  "dateModified" : "2013-11-05T13:48:51EST",
  "description" : "There is a problem identifying the meaning of key words for Oracle Knowledge",
  "recordId" : "2LKAJDFO8234OIJ3O24P18439837409819",
  "incidentId" : "140005-14895892",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ]
}
Back to Top