Get Documents listing

GET 
/documents

Returns a list of the most recent documents added, ordered by inserted, descending

Request

Query Parameters

siteId string

Site Identifier

actionStatus string

Possible values: [FAILED, IN_QUEUE, PENDING, RUNNING, SKIPPED, FAILED_RETRY]

Fetch documents with an action status

syncStatus string

Possible values: [FULLTEXT_METADATA_FAILED, FULLTEXT_CONTENT_FAILED]

Fetch documents with an sync status

softDeleted boolean

Fetch soft deleted documents

deleted booleandeprecated

Deprecated: use softDeleted. Fetch soft deleted documents

date string

Fetch documents inserted on a certain date (yyyy-MM-dd)

tz string

UTC offset to apply to date parameter (IE: -0600)

start date-time

Start of date-time range (UTC)

end date-time

End of date-time range (UTC)

sort string

Possible values: [ASC, DESC]

Sort order (default DESC)

next string

Next page of results token

previous string

Previous page of results token

projection string

Possible values: [DOCUMENT_ID_ONLY]

Specify a restricted document projection. Use 'DOCUMENT_ID_ONLY' to return only the documentId attribute.

limit string
Limit Results
Default value: 10

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 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

resourceType DocumentResourceType (string)

Document resource type

Possible values: [DOCUMENT, DOSSIER, DEEP_LINK]

insertedDate string

Inserted Timestamp

lastModifiedDate string

Last Modified Timestamp

deletedDate string

Soft Deleted Timestamp

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, SHA512]

documentId string

Document Identifier

artifactId string

Artifact Identifier

promotedArtifactId string

Promoted Artifact Identifier

artifactCategory string

Artifact Category

hasArtifacts boolean

Whether the document has artifact documents

contentType string

Document Content-Type

userId string

User who added document

contentLength integer

Document size

version string

Document version

versionKey string

Document Version Identifier

s3version string

Document storage version

belongsToDocumentId string

Parent Document Identifier

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",
      "resourceType": "DOCUMENT",
      "insertedDate": "string",
      "lastModifiedDate": "string",
      "deletedDate": "string",
      "checksum": "string",
      "checksumType": "SHA1",
      "documentId": "string",
      "artifactId": "string",
      "promotedArtifactId": "string",
      "artifactCategory": "string",
      "hasArtifacts": true,
      "contentType": "string",
      "userId": "string",
      "contentLength": 0,
      "version": "string",
      "versionKey": "string",
      "s3version": "string",
      "belongsToDocumentId": "string",
      "metadata": [
        {
          "key": "string",
          "value": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  ]
}

Loading...