REST API for Knowledge Advanced in B2C Service

Find by ID

get

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

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

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}
The request returns the Incident object with the recordId parameter specified with the request in the FULL mode.
http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}?mode=KEY
The request returns the Incident object with the recordId parameter specified with the request in the KEY mode.

Response Error

The possible error response for this method is as follows:

OK-GEN0013
The error is displayed when you specify the mode parameter value as DATA with the HTTP service request.

Request

Path Parameters

id: string

The unique identifier of the object to be retrieved.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : Incident

Match All

Show Source

allOf IncidentKey
object Incident-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/IncidentKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Incident object was created.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Incident object was last modified.</p>"
                },
                "description":{
                    "type":"string",
                    "description":"<p>The description of the Incident.</p>"
                }
            }
        }
    ]
}

Nested Schema : IncidentKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object IncidentKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The record Id of the Incident object.</p>"
                },
                "incidentId":{
                    "type":"string",
                    "description":"<p>The identifier of the Incident. This is also referred to as the case number.</p>"
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : IncidentKey-allOf[1]

Type: object

Show Source

incidentId(optional): string

The identifier of the Incident. This is also referred to as the case number.
recordId(optional): string

The record Id of the Incident object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The record Id of the Incident object.</p>"
        },
        "incidentId":{
            "type":"string",
            "description":"<p>The identifier of the Incident. This is also referred to as the case number.</p>"
        }
    }
}

Nested Schema : Incident-allOf[1]

Type: object

Show Source

dateAdded(optional): string(date-time)

The date when the Incident object was created.
dateModified(optional): string(date-time)

The date when the Incident object was last modified.
description(optional): string

The description of the Incident.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Incident object was created.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Incident object was last modified.</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>The description of the Incident.</p>"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

href: string

URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
mediaType(optional): string

Media type, as defined by RFC 2046, describing the link target.
method(optional): string

HTTP method for requesting the target of the link.
profile(optional): string

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
rel: string

Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
templated(optional): boolean

Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Examples

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

cURL Command

curl -X "GET" "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"}" \
-H "Accept: application/json"

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