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

Find by ID

get

/km/api/v1/tasks/workflowTasks/{id}

This method returns the WorkflowTask object having the specified workflow task ID.


Example URIs

The example URI for this method is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/tasks/workflowTasks/{id}

    The request returns all WorkflowTask object having the specified ID parameter.

Response Error

The possible error responses for this method are as follows:

  • OK-GEN0020

    The error occurs when the contentState request parameter is specified in the request.

  • OKDOM-GEN0001

    The error occurs when a WorkflowTask does not exist for the specified ID.

Request

Path Parameters
  • The unique identifier of the object to be retrieved.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : WorkflowTask
Match All
Show Source
Nested Schema : TaskData
Match All
Show Source
Nested Schema : TaskKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : TaskKey-allOf[1]
Type: object
Show Source
Nested Schema : TaskData-allOf[1]
Type: object
Show Source
Nested Schema : WorkflowTask-allOf[1]
Type: object
Show Source
Nested Schema : ContentKey
Match All
Show Source
Nested Schema : WorkflowStepKey
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 : WorkflowStepKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find the Workflow Task object specified by the 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/tasks/workflowTasks/{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" : "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://<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}"
  } ]
}
Back to Top