Module: document

Copyright 2020 Parsable, Inc
API address: /api/documents
Non-Thrift API.

Uploading a document

Retrieving a document

Retrieving a document locator (JSON object)


ModuleServicesData typesConstants
document Document

Data structures

Struct: Document

KeyFieldTypeDescriptionRequirednessDefault value
1idstringdefault
2mimeTypestringdefault
3namestringdefault
4sizei64default
5teamIdstringoptional
6isPendingboolif isPending = true, then it has not been uploaded yet defaultfalse
7md5Checksumstringdefault
8captionstringcharacter limit of common.MAX_DOCUMENT_CAPTION_LENGTH optional
9thumbnailIdstringif empty it could be a legacy or non-exec data file optional
10positiondoubleoptional
11creatorIdcommon.UUIDoptional
12sourcePlatformstringoptional
13createdAti64optional
14documentUrlstringoptional
15thumbnailUrlstringoptional
200latestChangediff.Changeoptional

A document represents any type of file that can be associated with jobs or job templates.