# documents - Catalog: `DocumentCloud` - Schema: `DocumentCloud` - Primary Keys: `id` - Select DocumentCloud API URL: `/documents` - Insert DocumentCloud API URL: `/documents` - Update DocumentCloud API URL: `/documents` - Delete DocumentCloud API URL: `/documents` - Field Selection Method: NotRequired 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. ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `access` | `string` | ☐ | | Filter by the access level. | | `created_at__gt` | `string` | ☐ | | 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` | `string` | ☐ | | 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` | `string` | ☐ | | Filter by projects which contain the given document. | | `id__in` | `string` | ☐ | | 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` | `boolean` | ☐ | | 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` | `string` | ☐ | | Filter by projects with the given slug. | | `status` | `string` | ☐ | | Filter by status. | | `title` | `string` | ☐ | | 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. | ## Columns of Table Function The columns of the table function `documents` 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. |