8.2.48 /api/v1/documents

This API endpoint is used to inspect or modify the backend's list of documents.

Supported HTTP methods: GET, POST, PATCH, HEAD, OPTIONS

GET /api/v1/documents/{documentId}

Gets the documents item with the given ID.

Parameters:

Expected Payload: none.

Replied Payload: An DocumentItem record with the given ID. The DocumentItem does not contain its 'fileContent' field, use the '/api/v1/documents/content/' API call to retrieve the document content.

Return Codes:

POST /api/v1/documents

Creates a new DocumentItem entry in the database.

Parameters: none.

Expected Payload:An DocumentItem record containing the fields of the record to create. The following rules apply:

• Fields which are null or missing are set to 'null' in the record.
• The field 'documentId' is ignored. The POST command creates a new record, the database assigns a unique documentId to the created record.
• The 'modified' field is set to the time when the command is executed, a 'modified' time specified in the supplied data is ignored.

Replied Payload: The created DocumentItem record. The DocumentItem does not contain its 'fileContent' field, use the '/api/v1/documents/content/' API call to retrieve the document content.

Return Codes:

PATCH /api/v1/documents/{documentId}

Modifies the documents item with the given ID.

Parameters:

Expected Payload:An DocumentItem record containing the fields to modify. The following rules apply:

• Fields which are null or missing are not changed in the record.
• To set a field to 'null' set it to an empty string.
• The field 'documentId' is ignored. The PATCH command modifies the record specified in the URI, the 'documentId' of this record never changes.
• The 'modified' field is set to the time when the command is executed, a 'modified' time specified in the supplied data is ignored.
• If the field 'fileContent' is contained, the stored file gets rewritten with this content.
• If 'fileName' and 'fileContent' are changed at the same time, the old file is deleted before writing the new one.

Replied Payload: The DocumentItem record after modification. The DocumentItem does not contain its 'fileContent' field, use the '/api/v1/documents/content/' API call to retrieve the document content.

Return Codes:

DELETE /api/v1/documents/{documentId}

Deletes the documents item with the given ID. This also deletes the file this record refers to.

Parameters:

Expected Payload: none.

Replied Payload: none.

Return Codes:

GET /api/v1/documents/content/{documentId}

Gets the file content of the document item with the given ID.

Parameters:

Expected Payload: none.

Replied Payload: The file content of the data file this document record refers to.

Return Codes:

POST /api/v1/documents/list

Gets a list of documents items matching the filter information sent with the request.

Parameters: none

Expected Payload: An DocumentItem document containing the filter to be applied. Any fields in the document which are missing or null are intepreted as a wildcard. Specified fields must all match to include the item in the returned list. If a 'modified' timestamp is given in the filter description, it is interpreted as 'must be modified at this time or later'. The 'fileContent' field is ignored as a filter.

Replied Payload: An array of DocumentItem records fulfilling the filter spec. The list is sorted by file name, 'a' to 'z'. The DocumentItem records do not contain their 'fileContent' field, this API call is intended to list the items, not to to execute a bulk read of the documents.

Return Codes: