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

Find all

get

/km/api/v1/tasks

This method returns a list of Task objects from the Oracle Knowledge repository.

This resource supports the orderBy request parameter, which allows you to sort the returned list of Tasks objects.

You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/tasks

Response Error

The possible error response for this method is as follows:

  • OK-GEN0020

    The error occurs when you specify the ContentState parameter with the request.


Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of Task objects that match the specified criteria.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/tasks

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/tasks?q=recordId eq???{recodId}???

    The request returns a Task object having the specified record ID.

  • http://<IM_REST_API_HOST>/km/api/latest/tasks?q=taskId eq ???{taskId}???

    The request returns a Task object having the specified task ID. DEMO2087 is a sample task ID.

  • http://<IM_REST_API_HOST>/km/api/latest/tasks?q=priority eq ???NONE???

    The request returns a list of Task objects that have the priority set as none.

  • http://<IM_REST_API_HOST>/km/api/latest/tasks?q=taskType eq ???WORKFLOW???

    The request returns a list of Task objects which have workflow as their task type.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=priority eq 'HIGH'

    The request returns a list of Task objects having the priority value as high.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=taskStatus eq 'OPEN'

    The request returns a list of Task objects having the task status value as open.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=ownerSiteId eq ???{id}???

    The request returns a Task object having the specified owner site ID.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=userAssigned eq ???{id}???

    The request returns a Task object having the specified userAssigned parameter value.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=userAssignedName eq 'Carol JinksT'

    The request returns a list of Task objects assigned to the specified user. Carol Jinks T is a sample user name in this example.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=resolution eq 'NEW'

    The request returns a list of Task objects having new as their resolution.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=taskIdNumber eq {id}

    The request returns a Task object having the specified task ID number.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=startDate onOrAfter '2009-10-01'

    The request returns a list of Task objects having October 1, 2009 as their start date.

  • http://<IM_REST_API_HOST>/km/api/latesttasks?q=userAssignedName eq '{name}' and taskStatus eq 'CLOSED' and taskType eq 'CONTENT_CHANGED'

    The request returns a list of all closed tasks assigned to the specified user. The list contains only task which have CONTENT_CHANGED as task type.

Response Error

The possible error response for this method is as follows:

  • OK-GEN0020

    The error occurs when you specify the ContentState parameter with the request.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

The unique identifier of the task record.

dateAddedYY'type' : 'string', 'format' : 'date-time'

The date when the task was created or added.

dateModifiedYY'type' : 'string', 'format' : 'date-time'

The date when the task was last modified.

priorityYY'enum' : ['LOW', 'MEDIUM', 'HIGH', 'NONE']

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

taskStatusYY'enum' : ['NEW', 'OPEN', 'UNASSIGNED', 'IGNORED', 'CLOSED', 'UNKNOWN']

The assigned status of the task. The valid values are as follows:

  • CLOSED
  • IGNORED
  • NEW
  • OPEN
  • UNASSIGNED
  • UNKNOWN
taskTypeYY'enum' : ['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
ageYY'type' : 'string'

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

taskNameYY'type' : 'string'

The name assigned to the task.

taskIdYY'type' : 'string'

The unique identifier of the task.

ownerSiteIdYY'type' : 'string'

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

userAssignedIdYY'type' : 'string'

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

userAssignedNameYY'type' : 'string'

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

userModifiedIdYY'type' : 'string'

The unique identifier of the user who modified the task.

userModifiedNameYY'type' : 'string'

The name of the user who modified the task.

startDateYY'type' : 'string', 'format' : 'date-time'

The date when the task become active.

sysCommentsYY'type' : 'string'

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

resolutionYY'type' : 'string'The resolution assigned to the task.
taskIdNumberYY'type' : 'integer'

The number assigned to the unique identifier of the task.

localeCodeYY'type' : 'string'

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

Request

Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList TaskData
Type: object
Title: ResultList TaskData
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : ResultList TaskData-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : TaskData
Match All
Show Source
Nested Schema : TaskKey
Match All
Show Source
Nested Schema : TaskKey-allOf[1]
Type: object
Show Source
Nested Schema : TaskData-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all Task objects from the Oracle Knowledge repository by submitting a get request on the REST resource using cURL.

cURL Command

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

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.

{
  "items" : [ {
    "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}"
    } ]
  }, 
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/tasks?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top