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

Find all

get

/km/api/v1/tasks/contentChangeTasks

Returns a list of ContentChangeTask objects in the system.

This resource supports the 'orderBy' request parameter which can be used to sort the returned paginated list.


Yields Errors:

  • OK-GEN0020 - If the 'contentState' request parameter is supplied with the request.

Find by query

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


Returns a list of ContentChangeTask objects that match the specified criteria.


Yields Errors:

  • OK-GEN0020 - If the 'contentState' request parameter is supplied 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', '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
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).

contentYN'$ref' : '#/definitions/ContentKey'Criteria field: content

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 ContentChangeTask
Type: object
Title: ResultList ContentChangeTask
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
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
  • Number of resource instances returned in the current range.
  • Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
  • Actual paging size used by the server.
  • Offset value used in the current page.
  • Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
Nested Schema : ResultList ContentChangeTask-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 : ContentChangeTask
Match All
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

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

    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.

Nested Schema : ContentChangeTask-allOf[1]
Type: object
Show Source
Nested Schema : ContentKey
Match All
Show Source
Nested Schema : ContentKey-allOf[1]
Type: object
Show Source
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all Content Change Task objects in the system 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/contentChangeTasks"

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" : [ {
    "content" : {
      "versionId" : "VERSIONID_VALUE",
      "documentId" : "DOCUMENTID_VALUE",
      "title" : "TITLE_VALUE",
      "version" : "VERSION_VALUE",
      "answerId" : 1428416791233,
      "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}"
      } ]
    },
    "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}"
    } ],
    "dateAdded" : "1807987-12-08T11:46:05EST",
    "dateModified" : "191370401-10-09T13:33:31EDT",
    "comments" : "COMMENTS_VALUE",
    "priority" : "NONE",
    "taskStatus" : "UNASSIGNED",
    "taskType" : "WORKFLOW_EXPIRATIION",
    "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:18EDT",
    "sysComments" : "SYSCOMMENTS_VALUE",
    "resolution" : "RESOLUTION_VALUE",
    "taskIdNumber" : 0,
    "localeCode" : "LOCALECODE_VALUE"
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/tasks/contentChangeTasks?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top