REST API for Knowledge Advanced in B2C Service

Get public document count

get

/km/api/v1/contentTypes/{contentTypeId}/publicDocumentCount

Returns public documents count of a content type, specified by content type Id

Request

Path Parameters

contentTypeId: string

The content type identifier

Response

Supported Media Types

application/json
application/xml

204 Response

No Content.

Root Schema : ContentTypeMetadata

Type: object

Title: ContentTypeMetadata

Show Source

documentAttachmentCount(optional): integer

DocumentAttachmentCount of the ContentTypeMetadata object
documentCount(optional): integer

DocumentCount of the ContentTypeMetadata object
publicDocumentCount(optional): integer

PublicDocumentCount of the ContentTypeMetadata object

{
    "title":"ContentTypeMetadata",
    "properties":{
        "documentCount":{
            "type":"integer",
            "description":"DocumentCount of the ContentTypeMetadata object"
        },
        "documentAttachmentCount":{
            "type":"integer",
            "description":"DocumentAttachmentCount of the ContentTypeMetadata object"
        },
        "publicDocumentCount":{
            "type":"integer",
            "description":"PublicDocumentCount of the ContentTypeMetadata object"
        }
    }
}

Examples

The following example shows how to find public documents count of a content type with the specified content type ID 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/{contentTypeId}/publicDocumentCount"

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.

{
  "documentCount" : 1435240111373,
  "documentAttachmentCount" : 1435240111374,
  "publicDocumentCount" : 143524011111375
}