McMainInstall

Summary

Update an existing Document by its ID with optional fields such as description, type ID, dates, and metadata.

Inputs

• id (required) — Identifier of the document to update.
• description — Short description of the document.
• typeId — ID of the document type.
• startDate — Start date for the document's validity period.
• endDate — End date for the document's validity period.
• terminateValue — Numeric value for the time interval between start and end.
• terminateIntervalId — Unit of the time interval (e.g., days, hours).
• comments — Free‑form commentary about the document.

Output shape

a single updated Document object

The response returns the full document record as it appears after the update; on failure an error envelope is returned.

Examples

Example 1: Update description and validity dates

Set Document ID to 98765, provide a new description 'Updated record', set startDate to '2025-01-01T00:00:00Z' and endDate to '2026-01-01T00:00:00Z'.

Example 2: Mark document as expired

Provide Document ID, set endDate to the current timestamp, optionally set terminateValue and terminateIntervalId to define expiry behavior.

Example 3: Bulk update using batching

Configure batchSize 100 and batchInterval 500ms to process multiple documents efficiently.