REST API for Knowledge Advanced in B2C Service

Find all

get

/km/api/v1/tasks/contentRecommendationTasks

This method returns a list of the ContentRecommendationTask objects from the Oracle Knowledge Repository.

This resource supports the orderBy request parameter, which allows you to sort the returned list of ContentRecommendationTask 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/contentRecommendationTasks

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks
The request returns a paginated list of ContentRecommendationTask objects from the Oracle Knowledge Repository.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks?mode=KEY
The request returns a paginated list of ContentRecommendationTask objects in KEY mode.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks?orderBy=dateAdded
The request returns a paginated list of ContentRecommendationTask objects in FULL mode. Objects in the list are sorted according to the date when the task was created.

Find by query

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

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

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

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

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

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks?q=priority eq 'HIGH'
The request returns a list of ContentRecommendationTask objects having the Priority value as HIGH.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks?q=priority eq 'HIGH' and taskName eq ???Recommendation for Doc'
The request returns a list of ContentRecommendationTask objects having the Priority value as HIGH and having task name as Recommendation for Doc.
http://<IM_REST_API_HOST>/km/api/latest/tasks/contentRecommendationTasks?q=priority eq 'HIGH'and locale.id eq 'en_U S'
The request returns a list of ContentRecommendationTask objects having the Priority value as HIGH and having US English as locale.

Query Parameters

The following table describes the query parameters for this resource.

Parameter	Queryable	Sortable	Type	Description
recordId	Y	Y	'type' : 'string'	The unique identifier of the task record.
dateAdded	Y	Y	'type' : 'string', 'format' : 'date-time'	The date when the task was created or added.
dateModified	Y	Y	'type' : 'string', 'format' : 'date-time'	The date when the task was last modified.
priority	Y	Y	'enum' : ['LOW', 'MEDIUM', 'HIGH', 'NONE']	The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.
taskStatus	Y	Y	'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
taskType	Y	Y	'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
age	Y	Y	'type' : 'string'	The age of a task. Age is calculated from the time of its creation to the current time.
taskName	Y	Y	'type' : 'string'	The name assigned to the task.
taskId	Y	Y	'type' : 'string'	The unique identifier of the task.
ownerSiteId	Y	Y	'type' : 'string'	The unique identifier of the repository to which the task belong to.
userAssignedId	Y	Y	'type' : 'string'	The unique identifier of the user to whom the task is assigned.
userAssignedName	Y	Y	'type' : 'string'	The name of the user to whom the task is assigned.
userModifiedId	Y	Y	'type' : 'string'	The unique identifier of the user who modified the task.
userModifiedName	Y	Y	'type' : 'string'	The name of the user who modified the task.
startDate	Y	Y	'type' : 'string', 'format' : 'date-time'	The date when the task become active.
sysComments	Y	Y	'type' : 'string'	The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.
resolution	Y	Y	'type' : 'string'	The resolution assigned to the task.
taskIdNumber	Y	Y	'type' : 'integer'	The number assigned to the unique identifier of the task.
localeCode	Y	Y	'type' : 'string'	The locale code of the task. For example, en_US is the locale for English (United States).
contentRecommendation	Y	N	'$ref' : '#/definitions/ContentRecommendationKey'	The recommendation to which the task refers.

Request

Query Parameters

limit: integer

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.
mode:

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" ]
offset: integer

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.
orderBy: string

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.
q: string

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.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList ContentRecommendationTask

Type: object

Title: ResultList ContentRecommendationTask

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.
object ResultList ContentRecommendationTask-allOf[1]

{
    "title":"ResultList ContentRecommendationTask",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentRecommendationTask"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Show Source

allOf Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.
object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : Base Collection Resource-allOf[1]

Type: object

Show Source

items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

count(optional): integer

Number of resource instances returned in the current range.
hasMore(optional): boolean

Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
limit(optional): integer

Actual paging size used by the server.
offset(optional): integer

Offset value used in the current page.
totalResults(optional): integer

Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList ContentRecommendationTask-allOf[1]

Type: object

Show Source

items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentRecommendationTask"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

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.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"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.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

Array of: ContentRecommendationTask

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentRecommendationTask"
    }
}

Nested Schema : ContentRecommendationTask

Match All

Show Source

allOf TaskData
object ContentRecommendationTask-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/TaskData"
        },
        {
            "properties":{
                "contentRecommendation":{
                    "$ref":"#/definitions/ContentRecommendationKey",
                    "description":"The recommendation to which the task refers."
                }
            }
        }
    ]
}

Nested Schema : TaskData

Match All

Show Source

allOf TaskKey
object TaskData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/TaskKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task was created or added.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task was last modified.</p>"
                },
                "comments":{
                    "type":"string",
                    "description":"<p>This field displays the comments assigned to the task.</p>"
                },
                "priority":{
                    "enum":[
                        "LOW",
                        "MEDIUM",
                        "HIGH",
                        "NONE"
                    ],
                    "description":"<p>The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
                },
                "taskStatus":{
                    "enum":[
                        "NEW",
                        "OPEN",
                        "UNASSIGNED",
                        "IGNORED",
                        "CLOSED",
                        "UNKNOWN"
                    ],
                    "description":"<p>The assigned status of the task. The valid values are as follows:</p> <ul> <li>CLOSED</li> <li>IGNORED</li> <li>NEW</li> <li>OPEN</li> <li>UNASSIGNED</li> <li>UNKNOWN</li> </ul>"
                },
                "taskType":{
                    "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"
                    ],
                    "description":"<p>The type of the task. The valid values are as follows:</p>  <ul> <li>CONTENT_CHANGED</li> <li>CONTENT_EXPIRATION</li> <li>CONTENT_RECOMMENDATION</li> <li>CUSTOM</li> <li>FORUM_MODERARTION_NOTIFICATION</li> <li>INACTIVE_ACCOUNT</li> <li>RATINGS_ANALYSIS</li> <li>REVIEW_DATE</li> <li>SUBSCRIPTION</li> <li>SURVEY_ANSWER</li> <li>TRANSLATION</li> <li>WORKFLOW</li> <li>WORKFLOW_CHANGED</li> <li>WORKFLOW_EXPIRATIION</li> </ul>"
                },
                "age":{
                    "type":"string",
                    "description":"<p>The age of a task. Age is calculated from the time of its creation to the current time.</p>"
                },
                "taskTypeDisplay":{
                    "type":"string",
                    "description":"<p>The type of the task.</p>"
                },
                "taskPriorityDisplay":{
                    "type":"string",
                    "description":"<p>The priority value assigned to the task.</p><p>The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
                },
                "taskName":{
                    "type":"string",
                    "description":"<p>The name assigned to the task.</p>"
                },
                "taskId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the task.</p>"
                },
                "ownerSiteId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the repository to which the task belong to.</p>"
                },
                "userAssignedId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user to whom the task is assigned.</p>"
                },
                "userAssignedName":{
                    "type":"string",
                    "description":"<p>The name of the user to whom the task is assigned.</p>"
                },
                "userModifiedId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who modified the task.</P>"
                },
                "userModifiedName":{
                    "type":"string",
                    "description":"<p>The name of the user who modified the task.</p>"
                },
                "startDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task become active.</p>"
                },
                "sysComments":{
                    "type":"string",
                    "description":"<p>The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.</p>"
                },
                "resolution":{
                    "type":"string",
                    "description":"The resolution assigned to the task."
                },
                "taskIdNumber":{
                    "type":"integer",
                    "description":"<p>The number assigned to the unique identifier of the task.</p>"
                },
                "localeCode":{
                    "type":"string",
                    "description":"<p>The locale code of the task. For example, en_US is the locale for English (United States).</p>"
                }
            }
        }
    ]
}

Nested Schema : TaskKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object TaskKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the task record.</p>"
                }
            }
        }
    ]
}

Nested Schema : TaskKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the task record.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the task record.</p>"
        }
    }
}

Nested Schema : TaskData-allOf[1]

Type: object

Show Source

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.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task was created or added.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task was last modified.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>This field displays the comments assigned to the task.</p>"
        },
        "priority":{
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH",
                "NONE"
            ],
            "description":"<p>The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
        },
        "taskStatus":{
            "enum":[
                "NEW",
                "OPEN",
                "UNASSIGNED",
                "IGNORED",
                "CLOSED",
                "UNKNOWN"
            ],
            "description":"<p>The assigned status of the task. The valid values are as follows:</p> <ul> <li>CLOSED</li> <li>IGNORED</li> <li>NEW</li> <li>OPEN</li> <li>UNASSIGNED</li> <li>UNKNOWN</li> </ul>"
        },
        "taskType":{
            "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"
            ],
            "description":"<p>The type of the task. The valid values are as follows:</p>  <ul> <li>CONTENT_CHANGED</li> <li>CONTENT_EXPIRATION</li> <li>CONTENT_RECOMMENDATION</li> <li>CUSTOM</li> <li>FORUM_MODERARTION_NOTIFICATION</li> <li>INACTIVE_ACCOUNT</li> <li>RATINGS_ANALYSIS</li> <li>REVIEW_DATE</li> <li>SUBSCRIPTION</li> <li>SURVEY_ANSWER</li> <li>TRANSLATION</li> <li>WORKFLOW</li> <li>WORKFLOW_CHANGED</li> <li>WORKFLOW_EXPIRATIION</li> </ul>"
        },
        "age":{
            "type":"string",
            "description":"<p>The age of a task. Age is calculated from the time of its creation to the current time.</p>"
        },
        "taskTypeDisplay":{
            "type":"string",
            "description":"<p>The type of the task.</p>"
        },
        "taskPriorityDisplay":{
            "type":"string",
            "description":"<p>The priority value assigned to the task.</p><p>The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
        },
        "taskName":{
            "type":"string",
            "description":"<p>The name assigned to the task.</p>"
        },
        "taskId":{
            "type":"string",
            "description":"<p>The unique identifier of the task.</p>"
        },
        "ownerSiteId":{
            "type":"string",
            "description":"<p>The unique identifier of the repository to which the task belong to.</p>"
        },
        "userAssignedId":{
            "type":"string",
            "description":"<p>The unique identifier of the user to whom the task is assigned.</p>"
        },
        "userAssignedName":{
            "type":"string",
            "description":"<p>The name of the user to whom the task is assigned.</p>"
        },
        "userModifiedId":{
            "type":"string",
            "description":"<p>The unique identifier of the user who modified the task.</P>"
        },
        "userModifiedName":{
            "type":"string",
            "description":"<p>The name of the user who modified the task.</p>"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task become active.</p>"
        },
        "sysComments":{
            "type":"string",
            "description":"<p>The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.</p>"
        },
        "resolution":{
            "type":"string",
            "description":"The resolution assigned to the task."
        },
        "taskIdNumber":{
            "type":"integer",
            "description":"<p>The number assigned to the unique identifier of the task.</p>"
        },
        "localeCode":{
            "type":"string",
            "description":"<p>The locale code of the task. For example, en_US is the locale for English (United States).</p>"
        }
    }
}

Nested Schema : ContentRecommendationTask-allOf[1]

Type: object

Show Source

contentRecommendation(optional): ContentRecommendationKey

{
    "properties":{
        "contentRecommendation":{
            "$ref":"#/definitions/ContentRecommendationKey",
            "description":"The recommendation to which the task refers."
        }
    }
}

Nested Schema : ContentRecommendationKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object ContentRecommendationKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the contentRecommendation object.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentRecommendationKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the contentRecommendation object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the contentRecommendation object.</p>"
        }
    }
}

Examples

The following example shows how to view the list of the ContentRecommendationTask objects from the Oracle Knowledge Repository. This resource supports the orderBy request parameter, which allows you to sort the returned list of ContentRecommendationTask objects.

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

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:

{
  "items" : [ {
    "contentRecommendation" : {
    },
    "comments" : "COMMENTS_VALUE",
    "priority" : "LOW",
    "taskStatus" : "IGNORED",
    "taskType" : "TRANSLATION",
    "age" : "AGE_VALUE",
    "taskTypeDisplay" : "TASKTYPEDISPLAY_VALUE",
    "taskPriorityDisplay" : "TASKPRIORITYDISPLAY_VALUE",
    "taskName" : "TASKNAME_VALUE",
    "ownerSiteId" : "OWNERSITEID_VALUE",
    "userAssignedName" : "USERASSIGNEDNAME_VALUE",
    "userModifiedName" : "USERMODIFIEDNAME_VALUE",
    "startDate" : "2013-05-23T19:30:15EDT",
    "sysComments" : "SYSCOMMENTS_VALUE",
    "resolution" : "RESOLUTION_VALUE",
    "taskIdNumber" : 0,
    "localeCode" : "LOCALECODE_VALUE"
  },