Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

Replace all supporting documents for a workflow

Replaces the entire supporting documents collection for the specified monitoring workflow with the provided array (full-replace PUT semantics). Use this endpoint to set the complete desired state in one call; to add a single new document without touching existing ones, use POST /monitoring-workflows/{workflowId}/supporting-documents. Supplying an empty array removes all supporting documents from the workflow — this is irreversible via this endpoint. Each element must supply fileUrl, fileType, and originalFileName (all required); createdAt, createdBy, state, expirationDate, and source are optional. Requires MONITORING_WORKFLOW_DETAILS_CREATE, MONITORING_WORKFLOW_DETAILS_UPDATE, and MONITORING_WORKFLOW_DETAILS_SUPPORTING_DOCUMENTS_CREATE. The tenant-id header is mandatory.

put/monitoring-workflows/{workflowId}/supporting-documents

Path parameters

workflowIdstring required

Monitoring workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

fileUrlstring required

URL of the supporting document file

fileTypestring required

Type of the supporting document

originalFileNamestring required

Original name of the uploaded file

createdAtstring

Date when the document was created

createdBystring

The user who created the record

statestring

The state associated with the supporting document

expirationDatestring

The expiration date of the supporting document

sourcestring

The source of the supporting document

Example request

[
  {
    "fileUrl": "tenant-1/monitoring-workflows/mw_123/supporting-documents/1729961373476_doc.pdf",
    "fileType": "Medical License",
    "originalFileName": "medical_license.pdf",
    "createdAt": "2024-01-15T10:00:00Z",
    "createdBy": "user@example.com",
    "state": "CA",
    "expirationDate": "2025-12-31",
    "source": "Manual Upload"
  }
]

Response

Supporting documents updated successfully

object required