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

Assign task

post

/km/api/v1/tasks/assignTask

This method assigns a task to a specific user.

You must provide a request payload and the URI of the task that you need to assign along with this method. The AssignTask object in the request payload contains a Task object and a User object. The Tasks object contains details about the task and the User object contains details about the user to whom you need to assign the task.

Request

Supported Media Types
Body ()
The object to assign a task. You must pass this entity in AssignTask object to close a task.
Root Schema : AssignTask
Type: object
Title: AssignTask
Show Source
Nested Schema : TaskKey
Match All
Show Source
Nested Schema : UserKey
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 : UserKey-allOf[1]
Type: object
Show Source
  • Email of the User object
  • 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.
  • 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.
  • User's full name
  • The unique record ID of the User object.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root 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

  • The age of a task. Age is calculated from the time of its creation to the current time.

  • This field displays the comments assigned to the task.

  • The date when the task was created or added.

  • The date when the task was last modified.

  • The locale code of the task. For example, en_US is the locale for English (United States).

  • The unique identifier of the repository to which the task belong to.

  • Allowed Values: [ "LOW", "MEDIUM", "HIGH", "NONE" ]

    The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.

  • The resolution assigned to the task.

  • The date when the task become active.

  • The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.

  • The unique identifier of the task.

  • The number assigned to the unique identifier of the task.

  • The name assigned to the task.

  • The priority value assigned to the task.

    The valid values are LOW, MEDIUM, HIGH, and NONE.

  • 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
  • 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", "RECOMMENDATION_CLOSED" ]

    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

  • The type of the task.

  • The unique identifier of the user to whom the task is assigned.

  • The name of the user to whom the task is assigned.

  • The unique identifier of the user who modified the task.

  • The name of the user who modified the task.

Back to Top

Examples

The following example shows how to assign a task to a specified user by submitting a post request on the REST resource using cURL.

cURL Command

Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/tasks/assignTask"

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.

{
  "userKeyBO" : {
"recordId": "RECORDID_VALUE",
"name":"NAME_VALUE",
"email":"EMAIL",
"externalId":"ID_VALUE",
"externalType":"ACCOUNT or CONTACT"
	},
  "taskKeyBO" : {
"recordId": "RECORDID_VALUE"
  }
}

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