invantive documentation
Forum di supporto InvantiveAccedi / Registrati

document_by_id: DocumentCloud Get Document

read only REST

  • Catalogo: DocumentCloud
  • Schema: DocumentCloud
  • Chiavi primarie: id
  • Label: Get Document

È possibile solo recuperare i dati.

Codice sorgente dell'API

  • Punto finale: /documents/{id}

Parametri

Name Tipo di dati Required Default Documentation
id varchar2 Filter by specific document ID.

Colonne della tabella

Di seguito sono riportate le colonne della tabella document_by_id. Ogni colonna ha un tipo di dati SQL. Un nuovo valore non nullo deve essere fornito per ogni colonna richiesta in ogni momento durante l'inserimento e l'aggiornamento.

Name Tipo di dati 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.