Get Documents

Get Documents. To search documents along a particular path, use the filter path such as in “folder1\folder2”. If no path is provided, then the query will be a global search as it searches from the root of the tree hierarchy.

GET /content/documentlists/{documentListName}/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

Query Parameters

filter · string

Mozu.Content.Contracts.PropertyType filter expression to match against document properties.

sortBy · string

Sort expression.

pageSize · integer<int32>

Page size

startIndex · integer<int32>

First item in the page to return from the total result set

includeInactive · boolean

if this call should include a adocument that isn't active in the given preview date

path · string

path from which to return documents

includeSubPaths · boolean · default: false

if true this call will populate Subpaths

queryScope · string · default: SpecifiedPathOnly

Determines if the path parameter is used to scope the query to the specified path or ignored for a global scope. Defaults to specified path only. Valid values are: SpecifiedPathOnly, Global

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

subPaths · string[] | null

totalCount · integer<int32>