Get custom metrics

get

/km/api/v1/contentTypes/{id}/customMetrics

This method returns a list of CustomMetric objects associated with the ContentType object having the specified ID parameter.

CustomMetric objects represent a unit of measure used to track activity on the content in a content type.

The contentTypes resource supports the orderBy request parameter, which allows you to sort the returned list of CustomMetric objects.

The orderBy parameter accepts the following parameter values along with the HTTP request:

  • recordId
  • referenceKey
  • name
  • dateAdded
  • dateModified

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/contentTypes{id}/customMetrics

    The request returns a list of CustomMetric objects associated with the specified ContentType object. By default, the CustomMetric objects are sorted according to the referenceKey value in ascending order.

  • http://<IM_REST_API_HOST>/km/api/latest/contentTypes{id}/customMetrics?orderBy=name

    The request returns a list of CustomMetric objects associated with the specified ContentType object. The CustomMetric objects are sorted according to the names in ascending order.

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}/customMetrics?orderBy=dateAdded:desc

    The request returns a list of CustomMetric objects associated with the specified ContentType object. The CustomMetric objects are sorted according to the date, on which the metric is added, in descending order.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList CustomMetricKey
Type: object
Title: ResultList CustomMetricKey
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 CustomMetricKey-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 : CustomMetricKey
Type: object
Title: CustomMetricKey
Show Source
  • Name of the CustomMetric object
  • The unique record ID of the CustomMetric object.
  • The reference key for the CustomMetric object. CustomMetric objects support multiple languages. This field can be used to identify the associated objects for all languages.
Back to Top

Examples

The following example shows how to find all Custom Metric objects associated with the Content Type object that has the specified ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/contentTypes/{id}/customMetrics"

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" : null,
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 0
}
Back to Top