DocMgt.RESTHelper 5.0.4487

DocMgt.RESTHelper

REST API client library for the DocMgt document management platform.

⚠️ Version 5.x Breaking Change

Version 5.x requires .NET 8.0 or higher. If your project targets .NET Framework 4.7.2 or .NET Standard 2.0, stay on version 4.x.

What changed in 5.x

• Fully async API — all methods now return Task<T> with Async suffix
• Replaced Newtonsoft.Json with System.Text.Json (no external dependencies)
• Modern C# 12 syntax and nullable reference types
• Multi-targets .NET 8, 9, and 10
• Namespace changed from DocMgt to DocMgt.RESTHelper
• Automatic v1/v2 API endpoint detection based on server version

Getting Started

Install

dotnet add package DocMgt.RESTHelper

Basic Usage

using DocMgt.RESTHelper;

// Connect with username/password
using var client = new dmRestHelper("https://yourserver.docmgt.com", "username", "password");

// Or connect with GUID token
using var client = new dmRestHelper("https://yourserver.docmgt.com", "your-guid");

// Login and get current user
var user = await client.LoginAsync();

// Get server info
var info = await client.GetInfoAsync();

Records

// Search records
var records = await client.SearchRecordsAsync("invoice", pageNum: 1, numPerPage: 25);

// Get a record by ID
var record = await client.GetRecordAsync(123);

// Create a new record
var newRecord = new Record();
newRecord.AddData("@NAME", "My New Record");
newRecord.AddData("Customer", "Acme Corp");
var saved = await client.SaveRecordAsync(newRecord);

// Delete a record
await client.DeleteRecordAsync(saved.ID);

Documents

// Get documents for a record
var docs = await client.GetDocumentsAsync(recordID: 123);

// Upload a document
var doc = new Document
{
    RecordID = 123,
    Name = "Invoice",
    FileName = "invoice.pdf",
    DocumentValue = File.ReadAllBytes("invoice.pdf")
};
var savedDoc = await client.SaveDocumentAsync(doc);

// Download a document
byte[] fileData = await client.DownloadDocumentAsync(savedDoc.ID);

// Download as PDF
byte[] pdfData = await client.DownloadDocumentAsPDFAsync(savedDoc.ID);

// Chunked upload for large files
await client.UploadDocumentAsync(docID, "largefile.pdf", fileData, chunkSizeMB: 10);

Workflow

// Get work items
var workItems = await client.GetWorkItemsAsync(pageNum: 1, numPerPage: 25);

// Complete a work item
await client.CompleteWorkItemAsync(workItemID: 456);

// Process with a specific option
await client.ProcessWorkItemAsync(workItemID: 456, optionGUID: "option-guid-here");

Users and Teams

// Get all users
var users = await client.GetUsersAsync();

// Find user by username
var user = await client.GetUserAsync("jsmith");

// Get all teams
var teams = await client.GetTeamsAsync();

Migrating from 4.x

Namespace Change

// 4.x
using DocMgt;

// 5.x
using DocMgt.RESTHelper;

Async Methods

All methods are now async. Add Async suffix and await:

// 4.x (synchronous)
var record = client.GetRecord(123);

// 5.x (async)
var record = await client.GetRecordAsync(123);

API Version Auto-Detection

The client automatically detects your server version on first call. Servers running 5.0+ use the new v2 endpoints (/rest/v2/), while older servers continue using v1 (/rest/). No code changes needed — it just works.

To manually override:

// Force v1 endpoints
client.ApiVersion = dmRestHelper.ApiVersionMode.V1;

// Force v2 endpoints
client.ApiVersion = dmRestHelper.ApiVersionMode.V2;

// Check what's being used
Console.WriteLine($"Server: {client.DetectedServerVersion}, Using v2: {client.UsingV2}");

Requirements

• .NET 8.0, 9.0, or 10.0
• DocMgt Server 3.05 or higher (some features require 3.33+)

Support

Visit docmgt.com for documentation and support.