DocumentById: Minox Document by ID
read only per partition REST
- Catalog:
Minox - Schema:
MasterDataDocument - Label: Document by ID
Retrieves a single document.
The data in this table is partitioned per value of the administration_code column.
Can only retrieve data.
API Source
- Endpoint:
/tenant/{tenant_id}/administration/{administration_id}/document/{document_id} - Operation:
get /tenant/{tenant_id}/administration/{administration_id}/document/{document_id}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
administration_ |
`` | Partition to retrieve data from. | ||
document_ |
`` | The identity of the document. |
Table Columns
The columns of the table DocumentById 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 |
|---|---|---|---|---|---|
document_ |
varchar2 |
Document Administration ID | filters on the platform, writable, document. |
The identification of the administration of the document | |
document_ |
varchar2 |
Document Created at | filters on the platform, writable, document. |
The creation date of the document | |
document_ |
varchar2 |
Document Debitor/Creditor Number | filters on the platform, writable, document. |
||
document_ |
varchar2 |
Document Deleted at | filters on the platform, writable, document. |
The deletion date of the document | |
document_ |
char |
Document Disabled | filters on the platform, writable, document. |
Whether the document has been disabled | |
document_ |
varchar2 |
Document Error | filters on the platform, writable, document. |
The error message that could arise with a document | |
document_ |
varchar2 |
Document ID | filters on the platform, writable, document. |
The identification of the document | |
document_ |
char |
Document Internal | filters on the platform, writable, document. |
Whether the document is internal | |
document_ |
varchar2 |
Document Memo | filters on the platform, writable, document. |
The memo attached to the document | |
document_ |
varchar2 |
Document Name | filters on the platform, writable, document. |
The name of the document | |
document_ |
varchar2 |
Document Owner ID | filters on the platform, writable, document. |
The identification of the owner of the document | |
document_ |
varchar2 |
Document Preview URL | filters on the platform, writable, document. |
False if the document is not a PDF, otherwise the previewUrl to access the pdf | |
document_ |
varchar2 |
Document Process | filters on the platform, writable, document. |
The current state of the process of the document | |
document_ |
varchar2 |
Document Received | filters on the platform, writable, document. |
The received date of the document | |
document_ |
varchar2 |
Document Source | filters on the platform, writable, document. |
The source of the document | |
document_ |
varchar2 |
Document Source Meta | writable | The source metadata of the document The JSON text of the nested object. | |
document_ |
varchar2 |
Document Status | filters on the platform, writable, document. |
The current status of the document | |
document_ |
varchar2 |
Document Subtype | filters on the platform, writable, document. |
The subtype of the document | |
document_ |
varchar2 |
Document Type | filters on the platform, writable, document. |
The type of the document | |
document_ |
varchar2 |
Document Updated at | filters on the platform, writable, document. |
The update date of the document |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver:
Changes of This Table, 26.0 to 27.0
-administration_code-administration_name