REST API for Knowledge Advanced in B2C Service

Find by ID

get

/km/api/v1/incidentLinks/{id}

This method returns the IncidentLink object having the specified ID parameter.

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/incidentLinks/{id}
The request returns an IncidentLink object having the specified ID in FULL mode. By default, the Content objects in the KEY mode for the published version of the content appear nested in the response.
http://<IM_REST_API_HOST>/km/api/incidentLinks/{id}?mode=KEY
The request returns an IncidentLink object having the specified recordId parameter in KEY mode without any nested content.
http://<IM_REST_API_HOST>/km/api/incidents/{id}/incidentLinks/{id}?contentState=LATESTVALID
The request returns an IncidentLink object having the specified ID in 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
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.

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 : IncidentLink

Match All

Show Source

allOf IncidentLinkKey
object IncidentLink-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/IncidentLinkKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the IncidentLink object was created or added.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the IncidentLink object was last modified.</p>"
                },
                "incident":{
                    "$ref":"#/definitions/IncidentKey",
                    "description":"<p>The Incident object to which a content is linked.</p>"
                },
                "document":{
                    "$ref":"#/definitions/ContentKey",
                    "description":"<p>The content object to which the incident is linked</p>"
                },
                "linkedBy":{
                    "$ref":"#/definitions/UserKey",
                    "description":"<p>The user object who linked content with incident</p>"
                }
            }
        }
    ]
}

Nested Schema : IncidentLinkKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the IncidentLink object.</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 : IncidentLinkKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the IncidentLink object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the IncidentLink object.</p>"
        }
    }
}

Nested Schema : IncidentLink-allOf[1]

Type: object

Show Source

dateAdded(optional): string(date-time)

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

The date when the IncidentLink object was last modified.
document(optional): ContentKey
incident(optional): IncidentKey
linkedBy(optional): UserKey

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the IncidentLink object was created or added.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the IncidentLink object was last modified.</p>"
        },
        "incident":{
            "$ref":"#/definitions/IncidentKey",
            "description":"<p>The Incident object to which a content is linked.</p>"
        },
        "document":{
            "$ref":"#/definitions/ContentKey",
            "description":"<p>The content object to which the incident is linked</p>"
        },
        "linkedBy":{
            "$ref":"#/definitions/UserKey",
            "description":"<p>The user object who linked content with 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"
    ]
}

Nested Schema : ContentKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
                },
                "versionId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
                },
                "documentId":{
                    "type":"string",
                    "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The tittle of the document.</p>"
                },
                "version":{
                    "type":"string",
                    "description":"Version of the Content object"
                },
                "answerId":{
                    "type":"integer",
                    "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                },
                "allTranslations":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentKey"
                    },
                    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</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 : UserKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
                },
                "externalType":{
                    "type":"string",
                    "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
                }
            }
        }
    ]
}

Nested Schema : ContentKey-allOf[1]

Type: object

Show Source

allTranslations(optional): array allTranslations

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.
answerId(optional): integer

The unique identifier that enables mapping between an answer and the content.
dateModified(optional): string(date-time)

The date when the content was last modified in the Oracle Knowledge Repository.
documentId(optional): string

The unique identifier of a document that indicates the content type in which the content is saved.
locale(optional): LocaleKey
recordId(optional): string

The unique identifier of the document. This ID is same in all versions in all locales of the document.
title(optional): string

The tittle of the document.
version(optional): string

Version of the Content object
versionId(optional): string

The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
        },
        "versionId":{
            "type":"string",
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The tittle of the document.</p>"
        },
        "version":{
            "type":"string",
            "description":"Version of the Content object"
        },
        "answerId":{
            "type":"integer",
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        },
        "allTranslations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
        }
    }
}

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

Array of: ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
}

Nested Schema : LocaleKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

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 : UserKey-allOf[1]

Type: object

Show Source

email(optional): string

Email of the User object
externalId(optional): integer

The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
externalType(optional): string

The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
name(optional): string

User's full name
recordId(optional): string

The unique record ID of the User object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
        },
        "externalType":{
            "type":"string",
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
        }
    }
}

Examples

The following example shows how to find the Incident Link object having 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/incidentLinks/{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: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}"
  } ]
}