Get document folders

GET 
/folders

Get list of documents in a folder

Request

Query Parameters

siteId string

Site Identifier

indexKey string

Index Key Identifier

path string

Path query parameter (must be URL Encoded)

limit string
Limit Results
Default value: 10
shareKey string

Share Identifier

next string

Next page of results token

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

previous string

Previous page of results token

documents

object[]

List of search result documents

Array [

siteId string

Site Identifier

path string

Path or Name of document

width string

Document Content Width property

height string

Document Content Height property

deepLinkPath string

Path or Name of deep link

insertedDate string

Inserted Timestamp

lastModifiedDate string

Last Modified Timestamp

folder boolean

Is Result a Document Folder

indexKey string

populated if search result are from an index

checksum string

Document checksum, changes when document file changes

checksumType ChecksumType (string)

The type of checksum to use for file validation

Possible values: [SHA1, SHA256]

documentId string

Document Identifier

contentType string

Document Content-Type

userId string

User who added document

contentLength integer

Document size

versionId string

Document version

belongsToDocumentId string

Parent Document Identifier

matchedAttribute

object

key string

Tag key

stringValue string

Attribute with string value

numberValue number

Attribute with number value

booleanValue boolean

Attribute with boolean value

matchedTag

object

key string

Tag key

value string

Tag value

type string

Tag type

matchedTags

object[]

Array [

key string

Tag key

value string

Tag value

type string

Tag type

]

tags

object

property name* any

attributes

object

property name*

SearchResultDocumentAttribute

stringValues string[]

Attribute with string values

numberValues number[]

Attribute with number values

booleanValue boolean

Attribute with boolean value

valueType AttributeValueType (string)

Attribute Value Type

Possible values: [BOOLEAN, KEY_ONLY, NUMBER, STRING, PUBLICATION, CLASSIFICATION, COMPOSITE_STRING, RELATIONSHIPS, WATERMARK]

metadata

object[]

List of document Metadata

Array [

key string

Metadata key

value string

Metadata value

values string[]

Metadata values

]

]

Example (from schema)

{
  "next": "string",
  "previous": "string",
  "documents": [
    {
      "siteId": "string",
      "path": "string",
      "width": "string",
      "height": "string",
      "deepLinkPath": "string",
      "insertedDate": "string",
      "lastModifiedDate": "string",
      "folder": true,
      "indexKey": "string",
      "checksum": "string",
      "checksumType": "SHA1",
      "documentId": "string",
      "contentType": "string",
      "userId": "string",
      "contentLength": 0,
      "versionId": "string",
      "belongsToDocumentId": "string",
      "matchedAttribute": {
        "key": "string",
        "stringValue": "string",
        "numberValue": 0,
        "booleanValue": true
      },
      "matchedTag": {
        "key": "string",
        "value": "string",
        "type": "string"
      },
      "matchedTags": [
        {
          "key": "string",
          "value": "string",
          "type": "string"
        }
      ],
      "tags": {},
      "attributes": {},
      "metadata": [
        {
          "key": "string",
          "value": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  ]
}

Loading...