Skip to main content

DocumentType

No description

type DocumentType {
  id: ID!
  dbId: String
  description: String
  formattedDescription: String
  usedInAppCamera: Boolean
  isIncomplete: Boolean
  isRemoved: Boolean
  isArchived: Boolean
  removedAt: String
  createdAt: String
  createdAtEpoch: EpochMS
  uploadedAt: String
  uploadedAtEpoch: EpochMS
  lastModified: String
  lastModifiedEpoch: EpochMS
  location: LocationType
  linkedId: String
  extraUrl: String
  extraUrlName: String
  status: String
  todoDescription: String
  dueDate: String
  assignees: [UserType]
  linkedDocuments(
  after: String
  first: Int
  formsPackageVersion: String
  sortAfter: DocumentSortAfter = CREATED_AT
  sortDirection: SortDirection = DESC
): DocumentLinkedDocumentsConnectionTypeConnection
  documentTypeCategory: DocumentTypeCategory
  fileType: String
  formData: String
  isFormDocument: Boolean
  isPinned: Boolean
  pinnedBy: UserType
  isOldFormDocument: Boolean
  isTextDocument: Boolean
  is360Degrees: Boolean
  textContent: String
  textContentBackground: String
  fileName: String
  exportFileName: String
  labels: [String]
  isProcessingThumbnails: Boolean
  thumbnailUrls: ThumbnailsType
  downloadUrl: String
  downloadUrlMetaData: FileMetaDataType
  mp3PreviewUrl: String
  pdfPreviewUrl: String
  videoPreviewUrl: String
  printableUrl: String
  pdfNumberOfPages: Int
  errorWhileProcessingThumbnail: Boolean
  errorWhileProcessingThumbnailMessage: String
  metaData: MetaDataType
  videoDurationInSeconds: Int
  videoDurationString: String
  videoFps: Int
  revisionCount: Int
  creator: UserType
  isCreatedByCurrentUser: Boolean
  lastModifiedCreator: UserType
  lastModifiedBy: UserType
  comments(
  includeDeleted: Boolean
): DocumentCommentsConnectionTypeConnection
  folder: FolderType
  highestFolderWithGivenLabel(
  label: String!
): FolderType
  integrationCallStats: IntegrationEntityStatsType
  activities: DocumentActivityConnectionTypeConnection
}

Fields​

DocumentType.id ● ID! non-null scalar​

The ID of an object

DocumentType.dbId ● String scalar​

DocumentType.description ● String scalar​

DocumentType.formattedDescription ● String scalar​

DocumentType.usedInAppCamera ● Boolean scalar​

DocumentType.isIncomplete ● Boolean scalar​

DocumentType.isRemoved ● Boolean scalar​

DocumentType.isArchived ● Boolean scalar​

DocumentType.removedAt ● String scalar​

DocumentType.createdAt ● String scalar​

DocumentType.createdAtEpoch ● EpochMS scalar​

the epoch time in milliseconds when the document was created

DocumentType.uploadedAt ● String scalar​

DocumentType.uploadedAtEpoch ● EpochMS scalar​

the epoch time in milliseconds when the document was uploaded

DocumentType.lastModified ● String scalar​

DocumentType.lastModifiedEpoch ● EpochMS scalar​

the epoch time in milliseconds when the document was last modified

DocumentType.location ● LocationType object​

DocumentType.linkedId ● String scalar​

DocumentType.extraUrl ● String scalar​

DocumentType.extraUrlName ● String scalar​

DocumentType.status ● String scalar​

DocumentType.todoDescription ● String scalar​

DocumentType.dueDate ● String scalar​

DocumentType.assignees ● [UserType] list object​

DocumentType.linkedDocuments ● DocumentLinkedDocumentsConnectionTypeConnection object​

DocumentType.linkedDocuments.after ● String scalar​

Returns the items in the list that come after the specified cursor.

DocumentType.linkedDocuments.first ● Int scalar​

Returns the first n items from the list.

DocumentType.linkedDocuments.formsPackageVersion ● String scalar​
DocumentType.linkedDocuments.sortAfter ● DocumentSortAfter enum​
DocumentType.linkedDocuments.sortDirection ● SortDirection enum​

DocumentType.documentTypeCategory ● DocumentTypeCategory enum​

returns the category of the document. for example image, pdf, textmemo, ...

DocumentType.fileType ● String scalar​

DocumentType.formData ● String scalar​

DocumentType.isFormDocument ● Boolean scalar​

DocumentType.isPinned ● Boolean scalar​

DocumentType.pinnedBy ● UserType object​

DocumentType.isOldFormDocument ● Boolean scalar​

You probably dont need this, because its just if you need to handle those documents differently from PDFs

DocumentType.isTextDocument ● Boolean scalar​

DocumentType.is360Degrees ● Boolean scalar​

DocumentType.textContent ● String scalar​

DocumentType.textContentBackground ● String scalar​

DocumentType.fileName ● String scalar​

DocumentType.exportFileName ● String scalar​

the filename this file should have when being exported. this will rename most files to a more consistent format.

DocumentType.labels ● [String] list scalar​

DocumentType.isProcessingThumbnails ● Boolean scalar​

DocumentType.thumbnailUrls ● ThumbnailsType object​

DocumentType.downloadUrl ● String scalar​

DocumentType.downloadUrlMetaData ● FileMetaDataType object​

DocumentType.mp3PreviewUrl ● String scalar​

DocumentType.pdfPreviewUrl ● String scalar​

DocumentType.videoPreviewUrl ● String scalar​

DocumentType.printableUrl ● String scalar​

DocumentType.pdfNumberOfPages ● Int scalar​

DocumentType.errorWhileProcessingThumbnail ● Boolean scalar​

DocumentType.errorWhileProcessingThumbnailMessage ● String scalar​

DocumentType.metaData ● MetaDataType object​

DocumentType.videoDurationInSeconds ● Int scalar​

DocumentType.videoDurationString ● String scalar​

DocumentType.videoFps ● Int scalar​

DocumentType.revisionCount ● Int scalar​

DocumentType.creator ● UserType object​

DocumentType.isCreatedByCurrentUser ● Boolean scalar​

DocumentType.lastModifiedCreator ● UserType object​

DocumentType.lastModifiedBy ● UserType object​

The user who last modified the document

DocumentType.comments ● DocumentCommentsConnectionTypeConnection object​

DocumentType.comments.includeDeleted ● Boolean scalar​

DocumentType.folder ● FolderType object​

DocumentType.highestFolderWithGivenLabel ● FolderType object​

DocumentType.highestFolderWithGivenLabel.label ● String! non-null scalar​

DocumentType.integrationCallStats ● IntegrationEntityStatsType object​

DocumentType.activities ● DocumentActivityConnectionTypeConnection object​

Returned by​

addLabelsToDocument mutation ● createDocumentFile mutation ● createDocumentFromExportJob mutation ● createDocumentFromUploadTransaction mutation ● createDocumentText mutation ● document query ● documentAdded subscription ● documentChanged subscription ● documentRemoved subscription ● documentsChanged subscription ● documentsFeed subscription ● ownDocumentByMetdata query ● pinDocument mutation ● removeLabelsFromDocument mutation ● replaceFileOnDocument mutation ● replaceFileOnDocumentWithUploadTransaction mutation ● unpinDocument mutation ● updateBackgroundOnTextDocument mutation ● updateDescriptionOnDocument mutation ● updateLabelsOnDocument mutation ● updateTextContentOnDocument mutation

Member of​

CommentType object ● DocumentLinkedDocumentsConnectionTypeEdge object ● DocumentMutationPayloadType object ● FolderDocumentsConnectionEdge object ● RevisionAndHistoryType object ● RootDocumentsEdge object ● ShareFolderDocumentsConnectionEdge object ● UserNotificationType object

Last updated on