document_by_id: DocumentCloud Get Document
read only REST
- Catalog:
DocumentCloud - Schema:
DocumentCloud - Primary Keys:
id - Label: Get Document
Can only retrieve data.
API Source
- Endpoint:
/documents/{id}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
id |
varchar2 |
Filter by specific document ID. |
Table Columns
The columns of the table document_by_id are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
access |
varchar2 |
The access level for the document. Defaults to 'private'. | |||
asset_ |
varchar2 |
The base URL to load this document’s static assets from. | |||
canonical_ |
varchar2 |
The canonical URL to view this document. | |||
created_ |
datetime |
Time stamp when this document was created. | |||
description |
varchar2 |
A brief description of the document. | |||
edit_ |
char |
Does the current user have edit access to this document. | |||
file_ |
varchar2 |
File hash. | |||
file_ |
varchar2 |
A URL to a publicly accessible document for the URL Upload Flow. | |||
force_ |
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_ |
varchar2 |
Original file extension. | |||
page_ |
int32 |
The number of pages in this document. | |||
page_ |
varchar2 |
The dimensions for all pages in the document. | |||
presigned_ |
varchar2 |
The pre-signed URL to directly PUT the PDF file to. | |||
publish_ |
datetime |
A timestamp when to automatically make this document public. | |||
published_ |
varchar2 |
The URL where this document is embedded. | |||
related_ |
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_ |
datetime |
Time stamp when the document was last updated. | |||
user |
int64 |
The ID for the user this document belongs to. |