管制文件

資料夾管理¶

取得文件庫清單 GetRootFolder¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Folder.GetRootFolder
var result = await UofxService.DMS.ISO.Folder.GetRootFolder();

輸入參數

無

回傳結果

IEnumerable<RootFolderModel>

屬性	型別	說明
Id	`Guid`	Folder Id
Code	`string`	文件庫代碼
Name	`string`	Folder 名稱
IsFromAI	`bool`	AI知識庫

取得文件庫的資料夾清單 Get¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Folder.Get
var result = await UofxService.DMS.ISO.Folder.Get(model);

輸入參數

GetFolderReqModel

屬性	型別	必填	預設值	說明
RootFolderCode	`string`	V		文件庫(根目錄資料夾)的代碼

回傳結果

IEnumerable<FolderModel>

屬性	型別	說明
Id	`Guid`	Folder Id
ParentId	`Guid?`	上一層Folder Id
Name	`string`	Folder 名稱
Path	`string`	文件夾路徑

新增資料夾 Add¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Folder.Add
var result = await UofxService.DMS.ISO.Folder.Add(model);

輸入參數

AddFolderReqModel

屬性	型別	必填	預設值	說明
RootFolderCode	`string`	V		文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V		新增資料夾的路徑，ex: folder1/folder2

回傳結果

IEnumerable<FolderModel> (同 Get 回傳結果)

刪除資料夾 Delete¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Folder.Delete
var result = await UofxService.DMS.ISO.Folder.Delete(model);

輸入參數

DeleteFolderReqModel

屬性	型別	必填	預設值	說明
RootFolderCode	`string`	V		文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V		刪除資料夾的路徑，ex: folder1/folder2

回傳結果

IEnumerable<FolderModel> (同 Get 回傳結果)

資料夾更名 Update¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Folder.Update
var result = await UofxService.DMS.ISO.Folder.Update(model);

輸入參數

UpdateFolderReqModel

屬性	型別	必填	說明
RootFolderCode	`string`	V	文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V	資料夾的路徑，ex: folder1/folder2
NewName	`string`		新名稱

回傳結果

IEnumerable<FolderModel> (同 Get 回傳結果)

文件管理¶

取得資料夾版本規則資訊 GetNewDocRule¶

金鑰權限需求: 文件中心 > 管理文件庫

文件上傳前，可透過此 API 取得要上傳的資料夾之文件編號、版號等規則資訊

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.GetNewDocRule
var result = await UofxService.DMS.ISO.Doc.GetNewDocRule(model);

輸入參數

GetNewDocRuleReqModel

屬性	型別	必填	預設值	說明
RootFolderCode	`string`	V		文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V		文件所在資料夾的路徑，ex: folder1/folder2

回傳結果

FolderRuleResponseModel

屬性	型別	說明
DocSerialRule	`int`	文件編號規則 (0:依資料夾, 1:自行編號)
DocVerRule	`int`	文件版號規則 (0:依資料夾, 1:自行編號)
ExpectedVersion	`string`	預計版號
AllowCustomVer	`bool`	允許保管者自訂版本號

取得版本規則資訊 (已存在的文件) GetCurrentDocRule¶

金鑰權限需求: 文件中心 > 管理文件庫

文件上傳版更前，可透過此 API 取得文件編號、版號等規則資訊

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.GetCurrentDocRule
var result = await UofxService.DMS.ISO.Doc.GetCurrentDocRule(model);

輸入參數

GetCurrentDocRuleReqModel

屬性	型別	必填	說明
RootFolderCode	`string`	V	文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V	文件所在資料夾的路徑，ex: folder1/folder2
DocName	`string`		文件名稱

回傳結果

FolderRuleResponseModel (同 GetNewDocRule 回傳結果)

新增文件 Add¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.Add
await UofxService.DMS.ISO.Doc.Add(model);

輸入參數

AddIsoDocReqModel

屬性	型別	必填	預設值	說明
UploadBy	`UserModel`			指定上傳者，如不指定則會以系統使用者身份上傳
RootFolderCode	`string`	V		文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V		資料夾的路徑，如要查詢根目錄，請輸入 '/'，ex: folder1/folder2
Document	`FileViewModel`			要上傳的檔案
IsCADFile	`bool`		false	是否為 CAD 圖檔
DocProperty	`AddDocPropertyModel`			文件的屬性設定

FileViewModel

屬性	型別	說明
Id	`Guid`	檔案識別碼
FileName	`string`	檔案名稱

AddDocPropertyModel

屬性	型別	預設值	說明
Name	`string`		文件名稱
DocSerial	`string`		文件編號
DocVerRule	`int`	0	文件版號規則(0:依資料夾, 1:自行編號)
DocVersion	`string`		文件版號
PublishDept	`string`		發行單位
ApplyDept	`string`		適用單位
StartTime	`DateTimeOffset?`		生效日
EndTime	`DateTimeOffset?`		到期日
Summary	`string`		文件摘要
Memo	`string`		版本備註

回傳結果

無

更新文件版本 Update¶

金鑰權限需求: 文件中心 > 管理文件庫

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.Update
await UofxService.DMS.ISO.Doc.Update(model);

輸入參數

UpdateIsoDocReqModel

屬性	型別	必填	說明
UploadBy	`UserModel`		指定上傳者，如不指定則會以系統使用者身份上傳
OriginalDocName	`string`		原始文件名稱
RootFolderCode	`string`	V	文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V	資料夾的路徑，如要查詢根目錄，請輸入 '/'，ex: folder1/folder2
Document	`FileViewModel`		要上傳的檔案
IsCADFile	`bool`		是否為 CAD 圖檔
DocProperty	`UpdateDocPropertyModel`		文件的屬性設定

FileViewModel (同 Add 輸入參數)
UpdateDocPropertyModel

屬性	型別	說明
Name	`string`	文件名稱
DocSerial	`string`	文件編號
DocVersion	`string`	文件版號
PublishDept	`string`	發行單位
ApplyDept	`string`	適用單位
StartTime	`DateTimeOffset?`	生效日
EndTime	`DateTimeOffset?`	到期日
Summary	`string`	文件摘要
Memo	`string`	版本備註

回傳結果

無

作廢管制文件 Cancel¶

金鑰權限需求: 文件中心 > 管理文件庫

文件作廢後無法復原，且「讀者」將無法再存取該文件

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.Cancel
await UofxService.DMS.ISO.Doc.Cancel(model);

輸入參數

CancelDocReqModel

屬性	型別	必填	說明
RootFolderCode	`string`	V	文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V	資料夾的路徑，如要查詢根目錄，請輸入 '/'，ex: folder1/folder2
DocName	`string`		文件名稱
Reason	`string`		原因

回傳結果

無

銷毀管制文件 Destroy¶

金鑰權限需求: 文件中心 > 管理文件庫

文件銷毀後無法復原，且所有使用者將無法再存取該文件

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.ISO.Doc.Destroy
await UofxService.DMS.ISO.Doc.Destroy(model);

輸入參數

DestroyDocReqModel

屬性	型別	必填	說明
RootFolderCode	`string`	V	文件庫(根目錄資料夾)的代碼
FolderPath	`string`	V	資料夾的路徑，如要查詢根目錄，請輸入 '/'，ex: folder1/folder2
DocName	`string`		文件名稱
Reason	`string`		原因

回傳結果

無