1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. Incident Links

Find all

get

/km/api/v1/incidentLinks

This method returns a list of IncidentLink objects from the Oracle Knowledge Repository.

This resource supports the orderBy request parameter, which allows you to sort the returned list of IncidentLink objects.

You can find 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 GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/incidentLinks

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/incidentLinks

    The request returns a paginated list of IncidentLink objects in the FULL mode. By default, the Content objects in the KEY mode for the published version of the content appear nested with the response. The objects in the list are sorted according to date when the object was created.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?mode=KEY

    The request returns a paginated list of IncidentLink objects in KEY mode without any nested content.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?mode=KEY&limit=20&offset=0&orderBy=dateModified:desc

    The request returns a paginated list of at most 20 IncidentLink objects in KEY mode. The list starts with the IncidentLink object at the position 0, and the objects are sorted by the most recently modified.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?contentState=LATESTVALID

    The request returns a paginated list of IncidentLink objects in the FULL mode. The Content objects in the KEY mode for the latest valid version of the content appear nested with the response.

Response Errors

The possible error responses for this method are as follows:

  • OKDOM-GEN0006

  • The 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.

  • OKDOM-CONT0121

    The error is displayed when you specify LATEST as the contentState value along with the HTTP Service request.

    The incidentLinks resource does not allow LATEST as contentState parameter value.

  • OK-GEN0013

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


Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of IncidentLink objects that match the specified criteria.

This resource supports the orderBy request parameter, which allows you to sort the returned list of IncidentLink objects.

You can find 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 GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/incidentLinks

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?q=document.documentId eq 'RE123'

    The request returns a paginated list of IncidentLink objects that are linked to a Content object having the documentId parameter value as RE123. By default, the Content objects in the KEY mode for the published version of the content appear nested with the response.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?q=document.documentId eq 'RE123' and filterMode.contentState eq 'LATESTVALID'

    The request returns a paginated list of IncidentLink objects that are linked to a Content object having the documentId parameter value as RE123. The Content objects in the KEY mode for the latest valid version of the content appear nested with the response.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?q=incident.incidentId eq '140005-14895892'

    The request returns a paginated list of IncidentLink objects that are linked to an Incident object with the incidentId parameter value as 140005-14895892.

  • http://<IM_REST_API_HOST>/km/api/incidentLinks?q=document.documentId eq 'RE123' and incident.incidentId eq '140005-14895892'

    The request returns a paginated list of the IncidentLink objects that represents the link between the Incident object having the incidentId as 140005-14895892 and the Content object having the documentId as RE123.

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 filterMode.contentState parameter with the HTTP service request.

    The valid values for filterMode.contentState parameter are: PUBLISHED, LATEST, and LATESTVALID.

  • OKDOM-CONT0121

    This error is displayed when you specify LATEST as the filterMode.contentState value along with the HTTP Service request.

    The IncidentLinks resource does not allow the LATEST as filterMode.contentState parameter value.

  • OK-GEN0013

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

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

The unique identifier of the IncidentLink object.

dateAddedYY'type' : 'string', 'format' : 'date-time'

The date when the IncidentLink object was created or added.

dateModifiedYY'type' : 'string', 'format' : 'date-time'

The date when the IncidentLink object was last modified.

incidentYN'$ref' : '#/definitions/IncidentKey'

The Incident object to which a content is linked.

documentYN'$ref' : '#/definitions/ContentKey'

The content object to which the incident is linked

linkedByYN'$ref' : '#/definitions/UserKey'

The user object who linked content with incident

Request

Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : IncidentLinkKey
Match All
Show Source
Nested Schema : IncidentLinkKey-allOf[1]
Type: object
Show Source
Nested Schema : ContentKey
Match All
Show Source
Nested Schema : IncidentKey
Match All
Show Source
Nested Schema : UserKey
Match All
Show Source
Nested Schema : ContentKey-allOf[1]
Type: object
Show Source
Nested Schema : allTranslations
Type: array

This field will return list of all translated content that the user can view

This field will only be populated if allTranslations query parameter is passed in with value true.

Show Source
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Nested Schema : IncidentKey-allOf[1]
Type: object
Show Source
Nested Schema : UserKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all Incident Link objects from Oracle Knowledge repository by submitting a get request on the REST resource using cURL.

cURL Command

Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/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.

{
  "items" : [ {
    "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}"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/incidentLinks?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top