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

Find all

get

/km/api/v1/contentUserVisits

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

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

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/contentUserVisits

    The request returns a paginated list of ContentUserVisit objects in the repository in FULL mode.

  • http://<IM_REST_API_HOST>/km/api/latest/contentUserVisits?mode=KEY&orderBy=dateModified

    The request returns a paginated list of ContentUserVisit objects from the repository in KEY mode. The object associated with the recently viewed contents appears on the top of the list.

Response Error

The possible error response for this method is as follows:

  • OK-GEN0013

    The error occurs if you specify the mode parameter value as DATA with the HTTP service request.


Find by query

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


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

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

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/contentUserVisits?q=dateAdded after '2015-02-01' or dateModified after '2015-02-01'

    The request returns a paginated list of ContentUserVisit objects that were created or modified after the February 1, 2015. The object is created because the end user visited the associated content on February 1, 2015.

  • http://<IM_REST_API_HOST>/km/api/latest/contentUserVisits?q=user.login eq jsmith&orderBy=dateModified

    The request returns a paginated list of ContentUserVisit objects for all the content that were viewed by the user named John Smith. The objects in the list are sorted by the date when the object was last modified in descending order.

  • http://<IM_REST_API_HOST>/km/api/latest/contentUserVisits?q=content.documentId eq FA123&orderBy=dateModified

    The request returns a paginated list of ContentUserVisit objects associated with the users who viewed the 123rd content on content type FAQ. The objects in the list are sorted by the date when the object was last modified in descending order.

Response Error

The possible error response for this method is as follows:

  • OK-GEN0013

    The error appears when you specify the mode parameter value as DATA with the HTTP service request.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'The unique identifier for the ContentUserVisit object.
contentYN'$ref' : '#/definitions/ContentKey'

The content that the user viewed.

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

The date when the user first viewed the content.

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

The latest date when the user viewed the content.

userYN'$ref' : '#/definitions/UserKey'

The user who viewed the 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 ContentUserVisit
Type: object
Title: ResultList ContentUserVisit
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 ContentUserVisit-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 : ContentUserVisit
Match All
Show Source
Nested Schema : ContentUserVisitKey
Match All
Show Source
Nested Schema : ContentUserVisitKey-allOf[1]
Type: object
Show Source
Nested Schema : ContentUserVisit-allOf[1]
Type: object
Show Source
Nested Schema : ContentKey
Match All
Show Source
Nested Schema : UserKey
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 : UserKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

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

cURL Command

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

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" : 0,
      "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" : "2014-06-06T18:29:11EDT",
    "dateModified" : "2014-06-06T18:29:11EDT",
    "user" : {
      "name" : "NAME_VALUE",
      "externalId" : 1402079351535,
      "externalType" : "EXTERNALTYPE_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}"
      } ]
    },
    "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}/contentUserVisits?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top