Please enable JavaScript to view this site.

Navigation: Schema: GenerateDocument > Tables


Generate a document for an employment - preview__Activity name :__ PostGenerateDocumentPreviewByEmploymentIdAndDocumentId__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).Generate a document for an employment and receive a preview. Via Qwoater.

Catalog: LoketNlRest

Schema: GenerateDocument

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

Select (REST) API URL: /providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview

Insert (REST) API URL: /providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview

Update (REST) API URL: /providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview

Delete (REST) API URL: /providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview

Field Selection Method: NotRequired

Select (REST) API Operation: post /providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PostGenerateDocumentPreviewByEmploymentIdAndDocumentId. 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.


Data Type


Default Value





Metadata for the document to be generated.




The unique identifier of the template




The unique identifier of the employment


Table Function Columns

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


Data Type









25-05-2022 14:15 Version 22.1.46-BETA+3385