Find by ID
/km/api/v1/tasks/contentRecommendationTasks/{id}
This method returns a ContentRecommendationTask object having the specified ID parameter.
Example URIs
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks/{id}
The request returns the ContentRecommendationTask object having specified ID parameter in FULL mode.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks/{id}?mode=KEY
The request returns the ContentRecommendationTask object having specified ID parameter in the KEY mode.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks/{id}?mode=DATA
The request returns the ContentRecommendationTask object having specified ID parameter in the DATA mode.
Response Error
The possible error response for this method is as follows:
- OKDOM-GEN0002
The error is displayed when the specified ID is invalid or it does not exist in the database.
Request
-
id: string
The unique identifier of the object to be retrieved.
Response
- application/json
- application/xml
200 Response
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
TaskKey-allOf[1]
object
Singular Resource
object
-
recordId(optional):
string
The unique identifier of the task record.
object
-
age(optional):
string
The age of a task. Age is calculated from the time of its creation to the current time.
-
comments(optional):
string
This field displays the comments assigned to the task.
-
dateAdded(optional):
string(date-time)
The date when the task was created or added.
-
dateModified(optional):
string(date-time)
The date when the task was last modified.
-
localeCode(optional):
string
The locale code of the task. For example, en_US is the locale for English (United States).
-
ownerSiteId(optional):
string
The unique identifier of the repository to which the task belong to.
-
priority(optional):
Allowed Values:
[ "LOW", "MEDIUM", "HIGH", "NONE" ]
The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.
-
resolution(optional):
string
The resolution assigned to the task.
-
startDate(optional):
string(date-time)
The date when the task become active.
-
sysComments(optional):
string
The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.
-
taskId(optional):
string
The unique identifier of the task.
-
taskIdNumber(optional):
integer
The number assigned to the unique identifier of the task.
-
taskName(optional):
string
The name assigned to the task.
-
taskPriorityDisplay(optional):
string
The priority value assigned to the task.
The valid values are LOW, MEDIUM, HIGH, and NONE.
-
taskStatus(optional):
Allowed Values:
[ "NEW", "OPEN", "UNASSIGNED", "IGNORED", "CLOSED", "UNKNOWN" ]
The assigned status of the task. The valid values are as follows:
- CLOSED
- IGNORED
- NEW
- OPEN
- UNASSIGNED
- UNKNOWN
-
taskType(optional):
Allowed Values:
[ "WORKFLOW", "TRANSLATION", "CONTENT_EXPIRATION", "WORKFLOW_CHANGED", "WORKFLOW_EXPIRATIION", "REVIEW_DATE", "RATINGS_ANALYSIS", "CONTENT_CHANGED", "SURVEY_ANSWER", "SUBSCRIPTION", "CUSTOM", "INACTIVE_ACCOUNT", "CONTENT_RECOMMENDATION", "CONTENT_IN_LIMBO_STATE", "FORUM_MODERARTION_NOTIFICATION" ]
The type of the task. The valid values are as follows:
- CONTENT_CHANGED
- CONTENT_EXPIRATION
- CONTENT_RECOMMENDATION
- CUSTOM
- FORUM_MODERARTION_NOTIFICATION
- INACTIVE_ACCOUNT
- RATINGS_ANALYSIS
- REVIEW_DATE
- SUBSCRIPTION
- SURVEY_ANSWER
- TRANSLATION
- WORKFLOW
- WORKFLOW_CHANGED
- WORKFLOW_EXPIRATIION
-
taskTypeDisplay(optional):
string
The type of the task.
-
userAssignedId(optional):
string
The unique identifier of the user to whom the task is assigned.
-
userAssignedName(optional):
string
The name of the user to whom the task is assigned.
-
userModifiedId(optional):
string
The unique identifier of the user who modified the task.
-
userModifiedName(optional):
string
The name of the user who modified the task.
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
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentRecommendationKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the contentRecommendation object.
Examples
The following example shows how to view a ContentRecommendationTask object having the specified ID parameter.
curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks/{id}"
Example of Response Header
The following shows an example of the response header.
-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \ -H "Accept: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "dateAdded" : "13504037-10-06T16:30:04EDT", "dateModified" : "116459413-10-06T12:30:21EDT", "comments" : "COMMENTS_VALUE", "priority" : "LOW", "taskStatus" : "UNKNOWN", "taskType" : "REVIEW_DATE", "age" : "AGE_VALUE", "taskTypeDisplay" : "TASKTYPEDISPLAY_VALUE", "taskPriorityDisplay" : "TASKPRIORITYDISPLAY_VALUE", "taskName" : "TASKNAME_VALUE", "taskId" : "TASKID_VALUE", "ownerSiteId" : "OWNERSITEID_VALUE", "userAssignedId" : "USERASSIGNEDID_VALUE", "userAssignedName" : "USERASSIGNEDNAME_VALUE", "userModifiedId" : "USERMODIFIEDID_VALUE", "userModifiedName" : "USERMODIFIEDNAME_VALUE", "startDate" : "2013-05-23T19:30:13EDT", "sysComments" : "SYSCOMMENTS_VALUE", "resolution" : "RESOLUTION_VALUE", "taskIdNumber" : 0, "localeCode" : "LOCALECODE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://localhost:7002/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://localhost:7002/km/api/{version}/metadata-catalog/{resourceName}" } ] }