invantive documentation
Invantive SupportforenAnmelden / Eintragen

documents: DocumentCloud

read only REST

  • Katalog: DocumentCloud
  • Schema: DocumentCloud
  • Primärschlüssel: id

Es können nur Daten abgerufen werden.

API-Quelle

  • Endpunkt: /documents

Parameter

Name Datentyp Required Default Documentation
access varchar2 Filter by the access level.
created_at__gt varchar2 Filter by documents created either before or after a given date.You may specify both to find documents created between two dates.This may be a date or date time, in the following formats: YYYY-MM-DD or YYYY-MM-DD+HH:MM:SS.
created_at__lt varchar2 Filter by documents created either before or after a given date.You may specify both to find documents created between two dates.This may be a date or date time, in the following formats: YYYY-MM-DD or YYYY-MM-DD+HH:MM:SS.
document varchar2 Filter by projects which contain the given document.
id__in varchar2 Filter by specific document IDs, passed in as comma separated values.
organization int64 Filter by the ID of the organization of the document.
page_count__gt int32 Filter by documents with more then the specified number of pages.
page_count__lt int32 Filter by documents with less than the specified number of pages.
page_count int32 Filter by documents with a specified number of pages.
private char Filter by private or public projects.Specify either true or false.
project int64 Filter by the ID of a project the document is in.
slug varchar2 Filter by projects with the given slug.
status varchar2 Filter by status.
title varchar2 Filter by projects with the given title.
user int64 Filter by the ID of the owner of the document.
user int64 Filter by the ID of the owner of the document.

Tabellenspalten

Die Spalten der Tabelle documents sind unten aufgeführt. Jede Spalte hat einen SQL-Datentyp. Beim Einfügen und Aktualisieren muss für jede erforderliche Spalte jederzeit ein neuer Wert angegeben werden der nicht Null ist.

Name Datentyp Label Required Marks Documentation
access varchar2 The access level for the document.Defaults to 'private'.
asset_url varchar2 The base URL to load this document’s static assets from.
canonical_url varchar2 The canonical URL to view this document.
created_at datetime Time stamp when this document was created.
description varchar2 A brief description of the document.
edit_access char Does the current user have edit access to this document.
file_hash varchar2 File hash.
file_url varchar2 A URL to a publicly accessible document for the URL Upload Flow.
force_ocr char Force OCR even if the PDF contains embedded text - only include if file_url is set, otherwise should set force_ocr on the call to the processing endpoint.
id int64 The ID for the document.
language varchar2 The language the document is in.Defaults to 'eng'.
organization int64 The ID for the organization this document belongs to.
original_extension varchar2 Original file extension.
page_count int32 The number of pages in this document.
page_spec varchar2 The dimensions for all pages in the document.
presigned_url varchar2 The pre-signed URL to directly PUT the PDF file to.
publish_at datetime A timestamp when to automatically make this document public.
published_url varchar2 The URL where this document is embedded.
related_article varchar2 The URL for the article about this document.
slug varchar2 The slug is a URL safe version of the title.
source varchar2 The source who produced the document.
status varchar2 The status for the document.
title varchar2 The document's title.
updated_at datetime Time stamp when the document was last updated.
user int64 The ID for the user this document belongs to.