Create manual link
/km/api/v1/content/docId/{docId}/documentLinks/manual
This method relates a content object with the specified Content at document or locale level.
If isRelatedAtDocLevel is set to true then content will be related to the specified content at document level otherwise it will be linked at specified locale
Response Errors
- OKDOM-GEN0001
The error occurs when an invalid id has been given.
- OKDOM-CONT0208
The error occurs when the content is already related to the passed in related content at document level.
- OKDOM-CONT0205
The error occurs when the content is already related to the passed in related content and locale.
- OKDOM-CONT0206
The error occurs when the content and passed in related content are same.
- OKDOM-CONT0207
The error occurs when the related content is not enabled for content type of the content or passed in related content.
Request
- application/json
- application/xml
-
docId: string
The document identifier.
object
RelatedContent
-
isRelatedAtDocLevel(optional):
boolean
Indicates whether the content is related to the specified content at document level. The default is false.
- relatedContent(optional): ContentKey
- relatedLocale(optional): LocaleKey
-
sourceLocale(optional):
LocaleKey
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentKey-allOf[1]
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
object
Singular Resource
object
-
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.
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.
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.
object
-
recordId(optional):
string
The unique identifier of the Locale object.
Response
204 Response
Examples
The following example shows how to relate a Content object with the specified Content at document level by submitting a post request on the REST resource using cURL.
cURL Command
curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/documentLinks/manual"
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.
{
"relatedContent" : {
"recordId" : "000220141586401891fd714a9007fd8"
},
"sourceLocale" : {
"recordId" : "en_US"
},
"relatedLocale" : {
"recordId" : "en_US"
},
"isRelatedAtDocLevel" : "false"
}
Example of Response Body
This request does not return any response body.