/rest/api/document

Provides access to document handling.

POST v1/documents

Creates a document.

Response
application/json; charset=UTF-8

DocumentMetaDataDTO - DTO that contains meta data information of a document.

Request
multipart/form-data

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
MultipartFormDataInput  
document
The document to create.
false
 
QUERY
String  
documentName
The name of the document to create.
false
 

Status Codes

Status Code
Description
670
General document error.
671
Document type is not supported.
674
Document is not provided.
675
Document not writable.
676
No sufficient rights for document action.

GET v1/documents/{documentPk}/edit

Returns a document in edit mode.

Response
application/octet-stream

Byte -  

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
documentPk
The pk of the document to edit.
false
 

Status Codes

Status Code
Description
670
General document error.
671
Document type is not supported.
672
Document not found.
673
Document is locked by another user or on another client.
676
No sufficient rights for document action.

GET v1/documents/{documentPk}/read

Returns a document in read mode.

Response
application/octet-stream

Byte -  

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
documentPk
The pk of the document to read.
false
 

Status Codes

Status Code
Description
670
General document error.
671
Document type is not supported.
672
Document not found.
676
No sufficient rights for document action.

POST v1/documents/{documentPk}/return

Returns a document.

Response
application/json; charset=UTF-8

DocumentMetaDataDTO - DTO that contains meta data information of a document.

Request
multipart/form-data

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
MultipartFormDataInput  
document
The document to return.
false
 
PATH
String  
documentPk
The pk of the document to return.
false
 
QUERY
String  
documentName
The name of the document to return.
false
 

Status Codes

Status Code
Description
670
General document error.
671
Document type is not supported.
672
Document not found.
673
Document is locked by another user or on another client.
675
Document not writable.
676
No sufficient rights for document action.

GET v1/documents/{dokumentPk}/discard

Discards a document.

Response
application/json; charset=UTF-8

DocumentMetaDataDTO - DTO that contains meta data information of a document.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
documentPk
The pk of the document to discard
false
 

Status Codes

Status Code
Description
670
General document error.
671
Document type is not supported.
672
Document not found.
673
Document is locked by another user or on another client.
676
No sufficient rights for document action.