Get View Documents

When fullSearch is true, performs an exhaustive search to ensure all matching documents are returned. May be slower on very large lists. Returns HTTP 400 if the document list exceeds the configured maximum size (default 100,000). Defaults to false, which performs a faster search optimized for recently updated documents.

GET /content/documentlists/{documentListName}/views/{viewName}/documents

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "activeDateRange": {
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "contentLength": 123,
      "contentMimeType": "<string>",
      "contentUpdateDate": "2023-11-07T05:31:56Z",
      "documentTypeFQN": "<string>",
      "extension": "<string>",
      "id": "<string>",
      "insertDate": "2023-11-07T05:31:56Z",
      "listFQN": "<string>",
      "name": "<string>",
      "path": "<string>",
      "properties": "<unknown>",
      "publishSetCode": "<string>",
      "publishState": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "subPaths": [
    "<string>"
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

documentListName · string · required

viewName · string · required

Query Parameters

filter · string

sortBy · string

pageSize · integer<int32>

startIndex · integer<int32>

includeInactive · boolean

fullSearch · boolean · default: false

When true, performs an exhaustive search guaranteeing all matching documents are returned. Slower than the default on large lists. Returns HTTP 400 if the document list exceeds the configured maximum size threshold (default 100,000). Defaults to false, optimizing for speed.

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

subPaths · string[] | null · read-only

totalCount · integer<int32>