Parameters: CustomOutputD3.CustomOutputD3REST

Prev Next

Parameter

Requirement

Description

Baseuri

mandatory (if called without http header)

Basic directory to your d.velop documents instance.

Example: https://meinecloud.d-velop.cloud

See d.velop HTTP Header.

apikey

mandatory (if called without http header)

The API key is the authentication key that can be used for accessing d.velop documents from third-party systems.

See d.velop HTTP Header.

repoid

mandatory

The d.3 repository ID of the repository where you want to store the generated file. 

filename

mandatory

Name of the generated file for storage in d.velop documents. The file type is determined by the file extension (.docx, .xlsx, .pptx, .pdf, .html, ...).

To generate a PDF document, specify a "filename" in the following format: SalesReport.pdf 

sourcecategory

mandatory

Key value specifying the document type in which the document should be stored.

This value can be determined from d.velop documents. See the corresponding d.velop developer documentation

property.key.name.eigenschaft

optional

The property parameter can be used to set the properties of the created document in d.velop documents.

This value can be determined from d.velop documents. See the corresponding d.velop developer documentation. (e.g.: https://.d-velop.cloud/dms/r//source).

Additionally, parameters of the DMSApp API can be used. See the corresponding d.velop developer documentationfor "behaviour-controlling parameters". An example is the dox42 parameter "property.property_state" which corresponds to the d.velop parameter dmsobject.property_state.

From v1.2.8.2 multi-field support. Storage via pipe-separated values. Example: Value1|Value2|Value3 

SpecialFormat

(only dox42ForDocuments)

optional

Special formats for specified file types.

  • For PDF documents, the PDF format can be specified, e.g. Possible values: PDFA1b and PDFForm.

  • For HTML, the option: HTMLCode can be set, then the text of the generated document is interpreted as HTML code.

Sign

(only dox42ForDocuments)

optional

Value: true

For PDF, a digital signature can be applied. The certificate and the associated password must be preconfigured in the web.config file.

updateDocumentID

optional

A document ID can be stored here, allowing an existing document to be replaced with the new document. The existing document is automatically moved to the "Archive" status. 

alterationText

(optional) mandatory when updateDocumentID

Mandatory for existing UpdateDocumentID. d.velop documents requires a note on the changes for an update. This can be set via the parameter.

documentdatafield

optional

Path to any document. This does not upload the generated document, but any file.

documentdataname

optional

This parameter can be used to dynamically set the name of the file in documentdatafield