Please enable JavaScript to view this site.

Navigation: Schema: DocumentCloud > Tables

document_by_id: DocumentCloud Get Document

Catalog: DocumentCloud

Schema: DocumentCloud

Primary Keys: id

Label: Get Document

This is a read-only table function. The DocumentCloud API may not support changing the data or the Invantive SQL driver for DocumentCloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the DocumentCloud API.

Select DocumentCloud API URL: /documents/{id}

Insert DocumentCloud API URL: /documents/{id}

Update DocumentCloud API URL: /documents/{id}

Delete DocumentCloud API URL: /documents/{id}

Field Selection Method: NotRequired

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function document_by_id. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

string

 

Filter by specific document ID.

 

Table Function Columns

The columns of the table function document_by_id are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

access

string

 

The access level for the document. Defaults to 'private'.

asset_url

string

 

The base URL to load this document’s static assets from.

canonical_url

string

 

The canonical URL to view this document.

created_at

datetime

 

Time stamp when this document was created.

description

string

 

A brief description of the document.

edit_access

boolean

 

Does the current user have edit access to this document.

file_hash

string

 

File hash.

file_url

string

 

A URL to a publicly accessible document for the URL Upload Flow.

force_ocr

boolean

 

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

string

 

The language the document is in. Defaults to 'eng'.

organization

int64

 

The ID for the organization this document belongs to.

original_extension

string

 

Original file extension.

page_count

int32

 

The number of pages in this document.

page_spec

string

 

The dimensions for all pages in the document.

presigned_url

string

 

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

string

 

The URL where this document is embedded.

related_article

string

 

The URL for the article about this document.

slug

string

 

The slug is a URL safe version of the title.

source

string

 

The source who produced the document.

status

string

 

The status for the document.

title

string

 

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.

 

15-06-2022 21:30 Version 22.0.232-PROD+3445