Jump to

• Request
• Response
• Examples

Get public document count

get

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

This method returns the number of public documents having a content type that matches the specified ID parameter.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• contentTypeId: string
  The content type identifier

Query Parameters

• totalDocumentCount(optional): string
  If this is true, then the response will have totalDocumentCount populated, and not publicDocumentCount

Back to Top

Response

Supported Media Types

• application/json
• application/xml

204 Response

No Content.

Body ()

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
• totalDocumentCount(optional): integer
  TotalDocumentCount of the ContentTypeMetadata object

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

Back to Top

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 -X GET "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/{contentTypeId}/publicDocumentCount" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "publicDocumentCount": 179
}

Back to Top