QualityDocD organizes all controlled documents under a single list atDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/juescoryisus/QualityDocD/llms.txt
Use this file to discover all available pages before exploring further.
/Documents. Every document starts as a Draft and progresses through a configurable approval workflow. This guide walks you through creating new documents, using the list filters, editing drafts, downloading attachments, and retiring approved content by marking it obsolete.
Creating a document
Navigate to/Documents/Create to open the creation form. All authenticated users can create documents. Once submitted successfully, the system auto-assigns a unique document code and redirects you to the document’s detail page.
Navigate to the form
In the sidebar, click Documents, then click the New Document button in the top-right corner of the list, or navigate directly to
/Documents/Create.Fill in the required fields
Complete the form fields described in the table below. Title and Category are required; all other fields are optional.
| Field | Required | Notes |
|---|---|---|
| Title | ✅ Yes | Maximum 500 characters. Displayed in the document list and search results. |
| Description | No | Free-text summary. Indexed by the search service. |
| Category | ✅ Yes | Used for filtering and compliance reports. Common values: Manual, Procedure, Record, Audit, Other. |
| Standard | No | The quality standard or regulation this document belongs to (e.g., ISO 9001). |
| Tags | No | Comma-separated keywords used for search indexing (e.g., quality,audit,2024). |
| IsPublic | No | When checked, the document is visible to all portal users, not just the document owner. |
| ExpiresAt | No | Optional expiry date. The detail page flags expired documents in red. |
Attach a file (optional)
Use the File field to upload a supporting document. See the Supported file types section below for the full list of accepted extensions. If no file is attached at creation time, you can add one later during an edit.
Document codes are assigned automatically as
QD-XXXX where XXXX is a zero-padded sequential number based on the total count of documents in the database at the time of creation. Codes are immutable once assigned.Supported file types
The following extensions are accepted for file attachments. Files with any other extension are rejected at upload time.| Category | Extensions |
|---|---|
| Documents | .pdf, .docx, .doc, .txt, .csv |
| Spreadsheets | .xlsx, .xls |
| Presentations | .pptx, .ppt |
| Images | .png, .jpg, .jpeg, .gif, .tif, .tiff |
| CAD & Engineering | .dwg, .dxf, .step, .stp, .iges |
| Archives | .zip, .7z |
Listing and filtering documents
The document list atGET /Documents shows all documents ordered by creation date (newest first). Use the filter bar at the top of the page to narrow results.
| Filter | Parameter | Description |
|---|---|---|
| Search | search | Matches against title, description, and document code. |
| Status | status | One of Draft, UnderReview, PendingChanges, UnderSecondReview, Approved, Rejected, Obsolete. |
| Category | category | Exact match on the document category. |
Editing a document
Only documents inDraft or PendingChanges status can be edited. Attempting to open the edit page for a document in any other status redirects you back to the detail page with an error message.
Navigate to GET /Documents/Edit/{id} or click the Edit button (pencil icon) from the list or detail page.
When you submit an edit with a new file attachment, the document’s version number increments automatically (e.g., from
v1 to v2). Editing metadata fields alone without replacing the file does not increment the version. After saving, the document status is reset to Draft regardless of its previous state.Downloading the attached file
Send aGET request to /Documents/Download/{id} (or click the Download button on the detail page) to retrieve the file. The response returns the file using its original filename and the correct MIME content type.
Downloaded audit log entry is created every time a file is downloaded, recording the user identity and IP address.
Marking a document as obsolete
Admins and Managers can retire any document by setting its status toObsolete. This action is available from the document detail page via the Obsolete button, which posts to:
| Current status | Can edit? | Can submit for review? | Can mark obsolete? |
|---|---|---|---|
Draft | ✅ | ✅ | ✅ Admin/Manager |
PendingChanges | ✅ | ✅ | ✅ Admin/Manager |
UnderReview | ❌ | ❌ | ✅ Admin/Manager |
UnderSecondReview | ❌ | ❌ | ✅ Admin/Manager |
Approved | ❌ | ❌ | ✅ Admin/Manager |
Rejected | ❌ | ❌ | ✅ Admin/Manager |
Obsolete | ❌ | ❌ | ❌ Already obsolete |