Incident links
/km/api/v1/incidents/{id}/incidentLinks
This method returns a paginated list of IncidentLink objects for all the Content objects linked to the Incident object with the specified ID parameter.
This resource supports the orderBy request parameter. You can use this parameter with the HTTP service request to sort the returned list.
You can find the different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use the GET method with the mediaType value as 'application/schema+json'
in the HTTP request.
The example URI to get the schema and catalog of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/incidentLinks
Response Errors
The possible error responses for this method are as follows:
- OKDOM-GEN0006
This error is displayed when you specify any invalid value as contentState parameter with the HTTP service request.
The valid values for contentState parameter are: PUBLISHED, LATEST, and LATESTVALID.
- $INVALID_CONTENTSTATE_FOR_SERVICE_CODE$
This error is displayed when you specify LATEST as the contentState value along with the HTTP Service request.
The incidentLinks resource does not allow the LATEST as contentState parameter value.
Example URIs
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}/incidentLinks
The request returns a paginated list of IncidentLink objects in the FULL mode. By default, objects in the list are sorted by date added. The nested Content objects are displayed for the published version of the content.
http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}/incidentLinks?mode=KEY&orderBy=recordId
The request returns a paginated list of IncidentLink objects in the KEY mode. Objects in the list are sorted by recordId. The nested Content objects are displayed for the published version of the content.
http://<IM_REST_API_HOST>/km/api/latest/incidents/{id}/incidentLinks?contentState=LATESTVALID
The request returns a paginated list of IncidentLink objects in the FULL mode. By default, objects in the list are sorted by the date added. The nested Content objects are displayed for the latest valid version of the content. Valid options for contentState include PUBLISHED and LATESTVALID.
Request
-
id: string
The incident's record ID
Response
- application/json
- application/xml
200 Response
object
ResultList IncidentLinkKey
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList IncidentLinkKey-allOf[1]
Collection Paging Resource
-
allOf
Base Collection Resource
Title:
Base Collection Resource
Oracle base collection resource schema definition. -
object
Collection Paging Resource-allOf[1]
Base Collection Resource
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
Base Collection Resource-allOf[1]
object
Singular Resource
object
-
count(optional):
integer
Number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
limit(optional):
integer
Actual paging size used by the server.
-
offset(optional):
integer
Offset value used in the current page.
-
totalResults(optional):
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
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.
object
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
IncidentLinkKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the IncidentLink object.
Examples
The following example shows how to find all Incident Link objects for all the Content objects linked to 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}/incidentLinks"
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:20EST", "dateModified" : "2013-11-05T13:48:20EST", "incident" : { "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}" } ] }, "document" : { "recordId" : "10834GALKGJ0187394813N401347981324", "versionId" : "1324IUH12934701324NL340987134KJN1341", "documentId" : "RE123", "title" : "Reference Document for Oracle Knowledge", "version" : "4.0", "answerId" : 0, "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}" } ] }, "recordId" : "321SDF6FO82346824P1842344409654SD14", "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}" } ] }