Ede.Uofx.Api.OAuth (1.0.0)
Download OpenAPI specification:
A .NET 8 Web API compliant with OpenAPI 3.1 standard, providing project management functionality
取得個人資料
金鑰權限要求： 系統 > 讀取個人資料
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Responses
Response samples
- 200
- 400
{- "name": "string",
- "employee_Number": "string",
- "email": "string",
- "dept_Name": "string",
- "corp_Name": "string"
}取得個人 BPM 待辦事項清單
金鑰權限要求： 表單 > 讀取個人待簽清單
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
查詢條件
| keyword | string or null 關鍵字(表單編號、主旨、欄位內容、附件名稱) |
| applicant_Date_From | string or null 起始時間 |
| applicant_Date_To | string or null 結束時間 |
Responses
Request samples
- Payload
{- "keyword": "string",
- "applicant_Date_From": "string",
- "applicant_Date_To": "string"
}Response samples
- 200
- 400
{- "items": [
- {
- "formName": "string",
- "subject": "string",
- "formSn": "string",
- "urgent": true,
- "applicantDate": "string",
- "url": "string"
}
]
}取得 BPM 表單詳細內容
金鑰權限要求： 表單 > 讀取單據內容
Authorizations:
path Parameters
| formSn required | string 表單編號 |
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Responses
Response samples
- 200
- 400
{- "form_Sn": "string",
- "form_Name": "string",
- "subject": "string",
- "urgent": true,
- "task_View_Status": "string",
- "applicant_Date": "string",
- "fields": [
- {
- "field_Name": "string",
- "code": "string",
- "value": null
}
], - "grids": [
- {
- "code": "string",
- "name": "string",
- "columns": [
- {
- "code": "string",
- "name": "string"
}
], - "rows": [
- {
- "property1": null,
- "property2": null
}
], - "sumByCode": {
- "property1": null,
- "property2": null
}, - "avgByCode": {
- "property1": null,
- "property2": null
}
}
]
}執行 BPM 表單簽核
金鑰權限要求： 表單 > 簽核表單
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
簽核請求資料
| formSn required | string non-empty 表單編號 |
| status required | integer <int32> [ 0 .. 1 ] 簽核狀態: 0=同意, 1=否決 |
| reason | string or null 原因說明 (否決、退回時需要填寫) |
Responses
Request samples
- Payload
{- "formSn": "string",
- "status": 1,
- "reason": "string"
}Response samples
- 200
- 400
{- "errorCode": "string",
- "traceId": "string"
}取得資料夾內的文件清單
Version： 1.0
金鑰權限要求： 文件中心 > 讀取目錄 / 文件
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
required | object (SearchPageOptionsOfListOrder) 分頁、排序選項 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string",
- "pageOptions": {
- "page": 0,
- "size": 0,
- "order": 0,
- "by": 0
}
}Response samples
- 200
- 400
{- "pageInfo": {
- "pageSize": 0,
- "itemsCount": 0,
- "pageNumber": 0,
- "pageCount": 0.1
}, - "items": [
- {
- "folder": "string",
- "document": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "fileName": "string",
- "length": 0
}, - "editor": {
- "itemType": 0,
- "dept": {
- "code": "string",
- "containsChildren": true,
- "isCompany": true
}, - "employee": {
- "userType": 0,
- "userCode": "string",
- "corpCode": "string"
}, - "jobTitleCode": "string",
- "jobFuncCode": "string"
}, - "modifiedDate": "2019-08-24T14:15:22Z",
- "allowDelete": true
}
]
}檢查檔案名稱是否已經存在於指定資料夾中
Version： 1.0
金鑰權限要求： 文件中心 > 管理文件
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
| documentNames required | Array of strings or null 要檢查的文件名稱 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string",
- "documentNames": [
- "string"
]
}Response samples
- 200
- 400
true新增文件到指定資料夾中
Version： 1.0
金鑰權限要求： 文件中心 > 管理文件
請先透過檔案上傳 API 上傳檔案並取得上傳資訊，然後再藉由此 API 將檔案加入到指定資料夾中。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
required | Array of objects or null (FileUploadRequestModel) 要上傳的文件 |
| duplicateAction required | integer <int32> 檔名重複的處理方式: 0 取代, 1 重新命名 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string",
- "documents": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileName": "string"
}
], - "duplicateAction": 0
}Response samples
- 200
- 400
true刪除文件
Version： 1.0
金鑰權限要求： 文件中心 > 管理文件
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
| fileName required | string or null 文件名稱 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string",
- "fileName": "string"
}Response samples
- 400
{- "errorCode": "string",
- "errorExpando": [
- {
- "error": "string",
- "expandoObject": null
}
], - "traceId": "string"
}取得文件庫清單
Version： 1.0
金鑰權限要求： 文件中心 > 讀取目錄 / 文件
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Responses
Response samples
- 200
- 400
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "code": "string",
- "isFromAI": true
}
]取得文件庫底下的子資料夾清單
Version： 1.0
金鑰權限要求： 文件中心 > 讀取目錄 / 文件
Authorizations:
path Parameters
| rootCode required | string |
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Responses
Response samples
- 200
- 400
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "path": "string"
}
]新增資料夾
Version： 1.0
金鑰權限要求： 文件中心 > 管理文件
注意，資料夾路徑上不存在的資料夾，皆會一起建立
例如目前僅有資料夾 folder1，資料夾路徑值為 /folder1/folder2/folder3 時，則會同步建立 folder2 和 folder3 資料夾。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string"
}Response samples
- 200
- 400
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "path": "string"
}
]刪除資料夾
Version： 1.0
金鑰權限要求： 文件中心 > 管理文件
被刪除的資料夾下的所有檔案和子資料夾都會被移至垃圾桶。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string"
}Response samples
- 200
- 400
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "path": "string"
}
]取得資料夾資訊
Version： 1.0
金鑰權限要求： 文件中心 > 讀取目錄 / 文件
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| rootFolderCode required | string or null 文件庫代碼 |
| folderPath required | string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄 |
Responses
Request samples
- Payload
{- "rootFolderCode": "string",
- "folderPath": "string"
}Response samples
- 200
- 400
[- {
- "role": 0,
- "allowDownloadFile": true,
- "allowDownloadPdf": true,
- "enableWatermark": true,
- "fullPath": [
- "string"
], - "allowDelete": true,
- "allowCancel": true,
- "allowDestroy": true
}
]chunk 上傳檔案
Version： 1.0
將檔案切割成多個小塊，逐一上傳，適合大檔案或不穩定網路環境。
此方法須自行處理檔案切割與合併，並確保每個 chunk 的順序正確。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema: multipart/form-data
| Id required | string <uuid> 檔案 ID，同一個檔案的 Chunk 上傳時需要保持一致 |
| FileName required | string 檔案名稱，同一個檔案的 Chunk 上傳時需要保持一致 |
| Length required | integer <int64> 檔案總大小，同一個檔案的 Chunk 上傳時需要保持一致 |
| ChunkFile required | string <binary> 檔案片段 |
| ChunkSize required | integer <int32> 切割的大小，同一個檔案的 Chunk 上傳時需要保持一致 |
| ChunkTotalCount required | integer <int32> 總共切割數量，同一個檔案的 Chunk 上傳時需要保持一致 |
| ChunkNumber required | integer <int32> 這次是第幾塊 |
Responses
Response samples
- 200
- 400
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileName": "string"
}透過檔案連結上傳
Version： 1.0
將檔案上傳到雲端硬碟，再透過檔案連結上傳到系統中。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| fileName required | string or null 檔案名稱 |
| url required | string or null 檔案下載連結 |
Responses
Request samples
- Payload
{- "fileName": "string",
- "url": "string"
}Response samples
- 200
- 400
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileName": "string"
}透過 base64 上傳
Version： 1.0
Request Body 大小限制： 10 MB
將檔案轉成 base64 字串後上傳，適合小檔案或圖片等。
Authorizations:
path Parameters
| version required | string |
header Parameters
| Api-Key | string API 金鑰 (選填) |
| App-Id | string App 識別碼 (選填) |
| CorpCode | string 公司代碼 (選填) |
Request Body schema:
| fileName required | string or null 檔案名稱 |
| base64Content required | string or null 檔案內容的 Base64 編碼 |
Responses
Request samples
- Payload
{- "fileName": "string",
- "base64Content": "string"
}Response samples
- 200
- 400
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileName": "string"
}