Jump to

• Request
• Response
• Examples

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

• id: string
  The unique identifier of the ContentType object

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ResultList CustomMetricKey

Type: object

Title: ResultList CustomMetricKey

Match All

Show Source

• allOf Collection Paging Resource
  Title: Collection Paging Resource

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

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

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 CustomMetricKey-allOf[1]

Type: object

Show Source

• items(optional): array items

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

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: object CustomMetricKey
  Title: CustomMetricKey

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

Nested Schema : CustomMetricKey

Type: object

Title: CustomMetricKey

Show Source

• name(optional): string
  Name of the CustomMetric object
• recordId(optional): string
  The unique record ID of the CustomMetric object.
• referenceKey(optional): string
  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.

{
    "title":"CustomMetricKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the CustomMetric object."
        },
        "referenceKey":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the CustomMetric object"
        }
    }
}

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