Ede.Uofx.Api.OpenApi (1.0.0)

Download OpenAPI specification:

A .NET 8 Web API compliant with OpenAPI 3.1 standard, providing project management functionality

部門管理

部門的新增、修改、刪除、查詢等功能，並支援批次移動部門。

取得公司全部部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"description": "string",
"active": true,
"seq": 0
}
]

建立部門

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

建立部門的模組

parentCode	string or null 父部門代碼，如果不給值則表示建立在最上層部門
code required	string or null 部門代碼
deptLevelCode required	string or null 部門層級代碼
name required	string or null 部門名稱
active required	boolean or null 是否啟用
description	string or null 備註

Responses

Request samples

Payload

Content type

application/json-patch+json

{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"active": true,
"description": "string"
}

Response samples

200
400

Content type

application/json

{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"description": "string",
"active": true,
"seq": 0
}

更新部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門的模組

originalCode required	string or null 原始部門代碼
code required	string or null 新的部門代碼
name required	string or null 新的部門名稱
deptLevelCode required	string or null 新的部門層級代碼
description	string or null 備註

Responses

Request samples

Payload

Content type

application/json-patch+json

{"originalCode": "string",
"code": "string",
"name": "string",
"deptLevelCode": "string",
"description": "string"
}

Response samples

200
400

Content type

application/json

{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"description": "string",
"active": true,
"seq": 0
}

取得部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

取得指定部門代碼 (code) 資料，includeSubDept 參數決定是否包含子部門資料。

Authorizations:

Bearer

path Parameters

code required	string 部門代碼
includeSubDept required	boolean 是否包含子部門
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"description": "string",
"active": true,
"seq": 0
}
]

更新部門狀態

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門狀態的模組

code required	string or null 部門代碼
active required	boolean 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"parentCode": "string",
"code": "string",
"deptLevelCode": "string",
"name": "string",
"description": "string",
"active": true,
"seq": 0
}

刪除部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

code required	string 部門代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

移動部門

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

移動部門的模組

parentCode	string or null 移至哪個父部門之下，如果不給值則表示移至最上層
code required	string or null 要移動的部門代碼
seq required	integer or null <int32> 在同父部門下的排序，必須 >= 0

Responses

Request samples

Payload

Content type

application/json-patch+json

{"parentCode": "string",
"code": "string",
"seq": 0
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

批次異動部門

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

注意，此 API 依照傳入的參數，可能會停用員工或移除員工兼任部門，請在確認其可能的風險再使用。

處置邏輯如下:

移動部門位置
要停用的部門如果包含子部門，則所有子部門也會被停用
要停用的部門如果還有員工，則其部門員工也會被停用，如員工為兼職則會被 移除兼職關係 (部門關聯)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

批次移動部門模組

required

Array of objects or null (DeptBatchMoveRequestItem)

要異動的部門

Responses

Request samples

Payload

Content type

application/json-patch+json

{"batchMove": [{"parentCode": "string",
"code": "string",
"seq": 0,
"active": true
}
]
}

Response samples

200
400

Content type

application/json

{"enableDept": ["string"
],
"disableDept": ["string"
],
"disableEmplOfAccount": ["string"
],
"disableEmplOfEmployeeNumber": ["string"
],
"removeSubDeptEmpl": [{"account": "string",
"emplNum": "string",
"deptCode": "string"
}
]
}

部門人員管理

取得公司所有的員工資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"active": true,
"locked": true
}
]

取得部門底下的員工資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

code required	string 部門代碼
includeSubDept required	boolean 是否包含自子部門
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"active": true,
"locked": true
}
]

部門主管管理

移除部門主管

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

code required	string 部門代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

取得部門主管資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

code required	string 部門代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"active": true,
"locked": true
}

更新部門主管

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門主管模組

code required	string or null 部門代碼
required	object (DeptManagerModel) 部門主管

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"manager": {"userType": 0,
"userCode": "string",
"corpCode": "string"
}
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

部門層級管理

取得部門層級資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"seq": 0,
"code": "string",
"name": "string",
"active": true
}
]

建立部門層級資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

新的部門層級會排在最後

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

建立部門層級模組

code required	string or null 代碼
name required	string or null 名稱
active	boolean or null 是否啟用，預設為 true

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"name": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"code": "string",
"name": "string",
"active": true
}

更新部門層級資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門層級模組

originalCode required	string or null 原始代碼
code required	string or null 新的代碼
name required	string or null 新的名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"originalCode": "string",
"code": "string",
"name": "string"
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"code": "string",
"name": "string",
"active": true
}

更新部門層級排序

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Seq 數字越小，層級越高

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門層級排序模組

code required	string or null 代碼
seq required	integer or null <int32> 新的排序位子，必須 >= 0

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"seq": 0
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"code": "string",
"name": "string",
"active": true
}

更新部門層級狀態

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新部門層級狀態模組

code required	string or null 代碼
active required	boolean or null 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"code": "string",
"name": "string",
"active": true
}

刪除部門層級資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

code required	string 部門層級代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

員工管理

取得員工資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"active": true,
"locked": true
}

取得跨公司員工資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

如果員工為跨公司員工，則需要提供原公司代碼才能查詢該員工的資料。

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
corpCode required	string 原公司代碼 (從其他公司兼職的員工，需要填寫原公司代碼)
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"active": true,
"locked": true
}

取得員工所屬部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"depts": [{"code": "string",
"name": "string",
"isMainDept": true,
"superVisorAccount": "string",
"superVisorEmplNumber": "string",
"jobTitle": {"code": "string",
"name": "string"
},
"jobFuncs": [{"code": "string",
"name": "string"
}
]
}
]
}

取得跨公司員工所屬部門資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
corpCode required	string 原公司代碼 (從其他公司兼職的員工，需要填寫原公司代碼)
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"depts": [{"code": "string",
"name": "string",
"isMainDept": true,
"superVisorAccount": "string",
"superVisorEmplNumber": "string",
"jobTitle": {"code": "string",
"name": "string"
},
"jobFuncs": [{"code": "string",
"name": "string"
}
]
}
]
}

鎖定或解鎖員工

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (EmployeeRequestModel) 員工
locked required	boolean or null 鎖定

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"locked": true
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工狀態（啟用/停用）

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工狀態模組

required	object (EmployeeRequestModel) 員工
active required	boolean or null 啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"active": true
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工帳號過期時間

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工帳號過期時間模組

required	object (EmployeeRequestModel) 員工
expiredTime required	string or null <date-time> 過期時間

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"expiredTime": "2019-08-24T14:15:22Z"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工離職時間

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工離職時間模組

required	object (EmployeeRequestModel) 員工
resignationDate required	string or null <date-time> 離職時間

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"resignationDate": "2019-08-24T14:15:22Z"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

刪除員工

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

刪除員工模組

userType required	integer <int32> 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string or null 使用者代碼，依照 UserType 的類型來決定是帳號還是員工編號。
corpCode	string or null 原公司代碼 (從其他公司兼職的員工，才需要在此填寫原公司代碼)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"userType": 0,
"userCode": "string",
"corpCode": "string"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工資料模組

account required	string or null 帳號
name required	string or null 中文姓名
loginValidation	Array of strings or null 登入驗證方式，請輸入 domain/id，例如: UOFAD/justin
employeeNumber	string or null 員工編號
gender	string or null 性別: Male, Female, Other
englishName	string or null 英文姓名
idCardNumber	string or null 身分證字號
birthDate	string or null <date-time> 生日
phoneNumber	string or null 電話號碼
businessCard	string or null 名片職稱
hireDate	string or null <date-time> 到職日
email	string or null 主要信箱
emailEx	string or null 其他信箱
required	object (EmployeeRequestModel) 員工

Responses

Request samples

Payload

Content type

application/json-patch+json

{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
}
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

建立員工

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

建立員工模組

account required	string or null 帳號
name required	string or null 中文姓名
loginValidation	Array of strings or null 登入驗證方式，請輸入 domain/id，例如: UOFAD/justin
employeeNumber	string or null 員工編號
gender	string or null 性別: Male, Female, Other
englishName	string or null 英文姓名
idCardNumber	string or null 身分證字號
birthDate	string or null <date-time> 生日
phoneNumber	string or null 電話號碼
businessCard	string or null 名片職稱
hireDate	string or null <date-time> 到職日
email	string or null 主要信箱
emailEx	string or null 其他信箱
expiredTime	string or null <date-time> 帳號到期時間
	Array of objects or null (EmplDeptCreateRequestModel) 公司職務

Responses

Request samples

Payload

Content type

application/json-patch+json

{"account": "string",
"name": "string",
"loginValidation": ["string"
],
"employeeNumber": "string",
"gender": "string",
"englishName": "string",
"idCardNumber": "string",
"birthDate": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"businessCard": "string",
"hireDate": "2019-08-24T14:15:22Z",
"email": "string",
"emailEx": "string",
"expiredTime": "2019-08-24T14:15:22Z",
"depts": [{"code": "string",
"isMainDept": true,
"jobTitleCode": "string",
"jobFuncs": ["string"
]
}
]
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工部門簽核主管

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工部門簽核主管模組

required	object (EmployeeRequestModel) 員工
deptCode required	string or null 要變更的部門代號
supervisorType required	integer or null <int32> 簽核類型: 0 依部門主管，1 依自訂簽核主管
	object (SupervisorRequestModel) 簽核主管

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"deptCode": "string",
"supervisorType": 0,
"supervisor": {"userType": 0,
"userCode": "string",
"corpCode": "string"
}
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工公司職務

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工公司職務

required	object (EmployeeRequestModel) 員工
required	Array of objects or null (EmplDeptUpdateRequestModel) 公司職務

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"depts": [{"code": "string",
"isMainDept": true,
"jobTitleCode": "string",
"jobFuncs": ["string"
]
}
]
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

更新員工主要部門

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

此 API 僅會更新員工的主要部門，原兼職部門不會異動。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新員工主要部門模組

required	object (EmployeeRequestModel) 員工
required	object (EmplDeptUpdateRequestModel) 更新公司職務

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"mainDept": {"code": "string",
"isMainDept": true,
"jobTitleCode": "string",
"jobFuncs": ["string"
]
}
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

職務類別管理

更新職務類別資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職務類別模組

originalCategory required	string or null 原本的職務類別名稱
category required	string or null 新的職務類別名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"originalCategory": "string",
"category": "string"
}

Response samples

200
400

Content type

application/json

{"name": "string",
"seq": 0
}

更新職務類別排序

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職務類別排序模組

category required	string or null 職務類別名稱
seq required	integer or null <int32> 排序，必須 >= 0

Responses

Request samples

Payload

Content type

application/json-patch+json

{"category": "string",
"seq": 0
}

Response samples

200
400

Content type

application/json

{"name": "string",
"seq": 0
}

刪除職務類別資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

name required	string 職務類別名稱
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

職務管理

取得職務資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[[{"categoryName": "string",
"code": "string",
"jobFunc": "string",
"active": true,
"seq": 0
}
]
]

建立職務資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

建立職務模組

code required	string or null 職務代碼
categoryName required	string or null 職務類別名稱
jobFunc required	string or null 職務名稱
active required	boolean or null 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"categoryName": "string",
"jobFunc": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"categoryName": "string",
"code": "string",
"jobFunc": "string",
"active": true,
"seq": 0
}

更新職務資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職務模組

originalCode required	string or null 原始職務代碼
code required	string or null 新職務代碼
jobFunc required	string or null 新職務名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"originalCode": "string",
"code": "string",
"jobFunc": "string"
}

Response samples

200
400

Content type

application/json

{"categoryName": "string",
"code": "string",
"jobFunc": "string",
"active": true,
"seq": 0
}

更新職務排序

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職務排序模組

code required	string or null 職務代碼
categoryName required	string or null 職務類別
seq required	integer or null <int32> 排序，必須 >= 0

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"categoryName": "string",
"seq": 0
}

Response samples

200
400

Content type

application/json

{"categoryName": "string",
"code": "string",
"jobFunc": "string",
"active": true,
"seq": 0
}

更新職務狀態

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職務狀態模組

code required	string or null 職務代碼
active required	boolean or null 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"categoryName": "string",
"code": "string",
"jobFunc": "string",
"active": true,
"seq": 0
}

刪除職務資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

code required	string 職務代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

職稱管理

職稱層級: 層級由 1 開始，往上遞增，越小代表層級越大，每個層級裡面可以有數個職稱

取得職稱資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[[{"seq": 0,
"rank": 0,
"code": "string",
"title": "string",
"active": true
}
]
]

建立職稱資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

建立職稱模組

code required	string or null 職稱代碼
title required	string or null 職稱名稱
rank required	integer <int32> 職稱層級，必須 >= 1
seq	integer or null <int32> 排序，必須 >= 1，如果無給值則排到所屬層級最後
active required	boolean or null 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"title": "string",
"rank": 0,
"seq": 0,
"active": true
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"rank": 0,
"code": "string",
"title": "string",
"active": true
}

更新職稱資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職稱模組

originalCode required	string or null 原始職稱代碼
code required	string or null 新職稱代碼
title required	string or null 新職稱名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"originalCode": "string",
"code": "string",
"title": "string"
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"rank": 0,
"code": "string",
"title": "string",
"active": true
}

更新職稱排序

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職稱排序模組

code required	string or null 職稱代碼
rank	integer or null <int32> 職稱層級，必須 >= 1，如無給值則表示不變更層級
seq	integer or null <int32> 排序，必須 >= 1，如無給值則排到所屬層級最後

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"rank": 0,
"seq": 0
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"rank": 0,
"code": "string",
"title": "string",
"active": true
}

更新職稱狀態

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

更新職稱狀態模組

code required	string or null 職稱代碼
active required	boolean or null 是否啟用

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"active": true
}

Response samples

200
400

Content type

application/json

{"seq": 0,
"rank": 0,
"code": "string",
"title": "string",
"active": true
}

刪除職稱資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

權限更新: 會異動組織資料，請在所有 API 異動後呼叫一次更新權限 API。

Authorizations:

Bearer

path Parameters

code required	string 職稱代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

組織權限管理

更新權限資料

Version： 1.0

金鑰權限要求： 組織 > 部門人員資料

所有組織的異動，皆可能造成部分權限的改變，因此在任何組織資料異動最後，都需要呼叫此 API 來更新權限資料。

為避免資源浪費，建議在組織所有資料異動最後，再呼叫此 API 一次即可。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

外部起單管理

取得表單起單資訊

Version： 1.0

金鑰權限要求： 表單 > 外部起單

Authorizations:

Bearer

path Parameters

formCodeOrId required	string 表單代碼或表單 ID
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"formCode": "string",
"allowApplyForm": true,
"fields": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"code": "string",
"typeId": "string",
"fieldHelper": "string",
"isRequired": true,
"notSupport": true,
"fields": [{ }
]
}
]
}

外部起單

Version： 1.0

金鑰權限要求： 表單 > 外部起單

Authorizations:

Bearer

path Parameters

formCodeOrId required	string 表單代碼或表單 ID
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (ApplyUserRequestModel) 申請者
deptCode required	string or null 申請者部門代碼
required	Array of objects or null (FieldModel) 表單欄位
opinion	string or null 備註
urgent	boolean or null 急件
	Array of objects or null (UploadFileModel) 夾帶檔案
customData	string or null CallBack 客製回傳資料
callBackUrl	string or null CallBack Url

Responses

Request samples

Payload

Content type

application/json-patch+json

{"applyAccount": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"deptCode": "string",
"fields": [{"code": "string",
"value": null
}
],
"opinion": "string",
"urgent": true,
"attachFiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileName": "string"
}
],
"customData": "string",
"callBackUrl": "string"
}

Response samples

200
400

Content type

application/json

"string"

表單管理

搜尋申請過的單據清單

Version： 1.0

金鑰權限要求： 表單 > 單據清單

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (ApplyUserRequestModel) 申請者
formCode	string or null 指定表單代碼
keyword	string or null 關鍵字
taskStatus required	integer <int32> 表單狀態: 0 所有狀態, 1 進行中, 2 已結案, 3 通過, 4 否決, 5 作廢, 6 異常
dateRangeType	integer or null <int32> 時間範圍類型: 0 依申請日期, 1 依簽核日期, 2 依結案日期, 3 依知會日期
	object (SearchDateRangeRequestModel) 搜尋時間範圍
required	object (SearchPageOptionsOfTaskListOrder) 分頁、排序選項

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"formCode": "string",
"keyword": "string",
"taskStatus": 0,
"dateRangeType": 0,
"dateRange": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"pageOptions": {"page": 0,
"size": 0,
"order": 0,
"by": 0
}
}

Response samples

200
400

Content type

application/json

{"pageInfo": {"pageSize": 0,
"itemsCount": 0,
"pageNumber": 0,
"pageCount": 0.1
},
"items": [{"formName": "string",
"subject": "string",
"formSn": "string",
"applicantDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"taskViewStatus": 0,
"allowedToRetrieve": true,
"allowedToCancel": true,
"url": "string"
}
]
}

搜尋待簽的單據清單

Version： 1.0

金鑰權限要求： 表單 > 單據清單

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (UserRequestModel) 使用者
formCode	string or null 指定表單代碼
taskStatus	integer or null <int32> 待處理表單狀態: 0 全部, 1 待簽核, 2 徵詢, 3 交接, 4 加簽
keyword	string or null 關鍵字(表單編號、主旨、欄位內容、附件名稱)
	object (SearchDateRangeRequestModel) 搜尋時間範圍
required	object (SearchPageOptionsOfTaskListOrder) 分頁、排序選項

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"formCode": "string",
"taskStatus": 0,
"keyword": "string",
"dateRange": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"pageOptions": {"page": 0,
"size": 0,
"order": 0,
"by": 0
}
}

Response samples

200
400

Content type

application/json

{"pageInfo": {"pageSize": 0,
"itemsCount": 0,
"pageNumber": 0,
"pageCount": 0.1
},
"items": [{"formName": "string",
"subject": "string",
"formSn": "string",
"urgent": true,
"nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
"applicantDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"isBranch": true,
"isAgent": true,
"isHandover": true,
"url": "string"
}
]
}

作廢表單

Version： 1.0

金鑰權限要求： 表單 > 單據清單

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (UserRequestModel) 使用者
formNo required	string or null 表單編號
reason required	string or null 作廢原因

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"formNo": "string",
"reason": "string"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

取得可申請的表單清單

Version： 1.0

金鑰權限要求： 表單 > 單據清單

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"categoryList": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "string"
}
],
"formList": [{"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"category": "string",
"name": "string",
"formCode": "string",
"url": "string"
}
]
}

取得跨公司兼職人員可申請的表單清單

Version： 1.0

金鑰權限要求： 表單 > 單據清單

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
corpCode required	string 原公司代碼 (從其他公司兼職的員工，需要填寫原公司代碼)
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

{"categoryList": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "string"
}
],
"formList": [{"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"category": "string",
"name": "string",
"formCode": "string",
"url": "string"
}
]
}

外部系統連線設定管理

取得外部連線設定

Version： 1.0

金鑰權限要求： 其他 > 外部連線

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"connId": "04d55352-2c86-456d-b797-47bde956c04e",
"code": "string",
"name": "string",
"connectionType": 0,
"editor": {"itemType": 0,
"dept": {"code": "string",
"containsChildren": true
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
},
"modifiedDate": "2019-08-24T14:15:22Z",
"hasUsed": true
}
]

取得跨公司兼職員工外部連線設定

Version： 1.0

金鑰權限要求： 其他 > 外部連線

Authorizations:

Bearer

path Parameters

userType required	integer <int32> (UserType) Enum: 0 1 使用者代碼類型: 0 帳號, 1 員工編號
userCode required	string 使用者代碼
corpCode required	string 原公司代碼 (從其他公司兼職的員工，需要填寫原公司代碼)
version required	string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"connId": "04d55352-2c86-456d-b797-47bde956c04e",
"code": "string",
"name": "string",
"connectionType": 0,
"editor": {"itemType": 0,
"dept": {"code": "string",
"containsChildren": true
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
},
"modifiedDate": "2019-08-24T14:15:22Z",
"hasUsed": true
}
]

表單簽核管理

針對簽核中表單進行簽核，例如同意、否決...等

同意

Version： 1.0

金鑰權限要求： 表單 > 外部起單

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (UserRequestModel) 使用者
nodeId required	string <uuid> 目前簽核站點 ID

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

否決

Version： 1.0

金鑰權限要求： 表單 > 外部起單

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (UserRequestModel) 使用者
nodeId required	string <uuid> 目前簽核站點 ID
opinion required	string or null 否決原因

Responses

Request samples

Payload

Content type

application/json-patch+json

{"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
"opinion": "string"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

文件管理

取得文件庫清單

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

Response samples

200
400

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"code": "string",
"isFromAI": true
}
]

取得文件庫底下的子資料夾清單

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

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

Content type

application/json

[{"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:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string"
}

Response samples

200
400

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"path": "string"
}
]

刪除資料夾

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

被刪除的資料夾下的所有檔案和子資料夾都會被移至垃圾桶。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string"
}

Response samples

200
400

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"path": "string"
}
]

重新命名資料夾

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄
newName required	string or null 資料夾新名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"newName": "string"
}

Response samples

200
400

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"path": "string"
}
]

取得資料夾權限資訊

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string"
}

Response samples

200
400

Content type

application/json

{"readers": [{"itemType": 0,
"dept": {"code": "string",
"containsChildren": true
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
}
]
}

更新資料夾權限資訊

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄
required	Array of objects or null (UserSetRequestItem) 讀者

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"readers": [{"itemType": 0,
"dept": {"code": "string",
"containsChildren": true
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
}
]
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

取得資料夾內的文件清單

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄
required	object (SearchPageOptionsOfListOrder) 分頁、排序選項

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"pageOptions": {"page": 0,
"size": 0,
"order": 0,
"by": 0
}
}

Response samples

200
400

Content type

application/json

{"pageInfo": {"pageSize": 0,
"itemsCount": 0,
"pageNumber": 0,
"pageCount": 0.1
},
"items": [{"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
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
},
"modifiedDate": "2019-08-24T14:15:22Z",
"allowDelete": true
}
]
}

檢查檔案名稱是否已經存在於指定資料夾中

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄
documentNames required	Array of strings or null 要檢查的文件名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"documentNames": ["string"
]
}

Response samples

200
400

Content type

application/json

true

新增文件到指定資料夾中

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

請先透過檔案上傳 API 上傳檔案並取得上傳資訊，然後再藉由此 API 將檔案加入到指定資料夾中。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

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

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"documents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileName": "string"
}
],
"duplicateAction": 0
}

Response samples

200
400

Content type

application/json

true

刪除文件

Version： 1.0

金鑰權限要求： 文件中心 > 管理文件庫 (僅限指定的文件庫)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

rootFolderCode required	string or null 文件庫代碼
folderPath required	string or null 資料夾路徑，例如: /folder1/folder2/folder3，如果只有 / 則為根目錄
fileName required	string or null 文件名稱

Responses

Request samples

Payload

Content type

application/json-patch+json

{"rootFolderCode": "string",
"folderPath": "string",
"fileName": "string"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

打卡管理

取得個人出勤打卡記錄

Version： 1.0

金鑰權限要求： 打卡 > 打卡紀錄

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (SearchDateRangeRequestModel) 搜尋時間範圍
timeZoneId required	string or null 時區Id (ex: "Taipei Standard Time")
queryPunchHistoryType required	integer or null <int32> 打卡類型類型: 0 全部, 1 出勤, 2 外出
required	object (EmployeeRequestModel) 員工

Responses

Request samples

Payload

Content type

application/json-patch+json

{"dateRange": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"timeZoneId": "string",
"queryPunchHistoryType": 0,
"user": {"userType": 0,
"userCode": "string",
"corpCode": "string"
}
}

Response samples

200
400

Content type

application/json

[{"corpCode": "string",
"account": "string",
"employeeNo": "string",
"punchDate": "2019-08-24T14:15:22Z",
"punchType": 0,
"location": "string",
"remark": "string"
}
]

取得部門員工出勤打卡記錄

Version： 1.0

金鑰權限要求： 打卡 > 打卡紀錄

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (SearchDateRangeRequestModel) 搜尋時間範圍
timeZoneId required	string or null 時區Id (ex: "Taipei Standard Time")
queryPunchHistoryType required	integer or null <int32> 打卡類型類型: 0 全部, 1 出勤, 2 外出
deptCode required	string or null 部門代號
includeSubDept	boolean or null 是否包含子部門，預設為 false

Responses

Request samples

Payload

Content type

application/json-patch+json

{"dateRange": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"timeZoneId": "string",
"queryPunchHistoryType": 0,
"deptCode": "string",
"includeSubDept": true
}

Response samples

200
400

Content type

application/json

[{"corpCode": "string",
"account": "string",
"employeeNo": "string",
"punchDate": "2019-08-24T14:15:22Z",
"punchType": 0,
"location": "string",
"remark": "string",
"deptCode": "string"
}
]

問卷管理

取得問卷清單

Version： 1.0

金鑰權限要求： 問卷 > 問卷管理 (僅限指定的問卷類別)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

code	string or null 指定問卷代碼
status required	integer <int32> 問卷狀態: 0 調查中, 1 待調查, 2 結束調查, 3 草稿
	object (SearchDateRangeRequestModel) 搜尋時間範圍

Responses

Request samples

Payload

Content type

application/json-patch+json

{"code": "string",
"status": 0,
"dateRange": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
}
}

Response samples

200
400

Content type

application/json

[{"code": "string",
"topic": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
]

複製並發佈問卷

Version： 1.0

金鑰權限要求： 問卷 > 問卷管理 (僅限指定的問卷類別)

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

sourceQueCode required	string or null 複製來源的問卷代碼
newTopic	string or null 新標題，如果不指定則使用原標題
topicMode	integer or null <int32> 標題更新模式，如果有給新標題，則使用此模式來決定如何更新標題，預設為覆蓋。 0 覆蓋, 1 附加在原字串之前, 2 附加在原字串之後
startTime required	string <date-time> 調查時間起
endTime required	string <date-time> 調查時間迄
	Array of objects or null (UserSetRequestItem) 調查對象，如果不指定則使用原問卷的調查對象

Responses

Request samples

Payload

Content type

application/json-patch+json

{"sourceQueCode": "string",
"newTopic": "string",
"topicMode": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"surveyUsers": [{"itemType": 0,
"dept": {"code": "string",
"containsChildren": true
},
"employee": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"jobTitleCode": "string",
"jobFuncCode": "string"
}
]
}

Response samples

200
400

Content type

application/json

{"hasSettingError": true,
"hasContentError": true,
"settingErrors": ["string"
],
"questionErrors": {"errors": ["string"
],
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"seq": 0,
"errorCode": "string"
}
]
}
}

檔案上傳

chunk 上傳檔案

Version： 1.0

將檔案切割成多個小塊，逐一上傳，適合大檔案或不穩定網路環境。

此方法須自行處理檔案切割與合併，並確保每個 chunk 的順序正確。

Authorizations:

Bearer

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

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileName": "string"
}

透過檔案連結上傳

Version： 1.0

將檔案上傳到雲端硬碟，再透過檔案連結上傳到系統中。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

fileName required	string or null 檔案名稱
url required	string or null 檔案下載連結

Responses

Request samples

Payload

Content type

application/json-patch+json

{"fileName": "string",
"url": "string"
}

Response samples

200
400

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileName": "string"
}

透過 base64 上傳

Version： 1.0

Request Body 大小限制： 10 MB

將檔案轉成 base64 字串後上傳，適合小檔案或圖片等。

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

fileName required	string or null 檔案名稱
base64Content required	string or null 檔案內容的 Base64 編碼

Responses

Request samples

Payload

Content type

application/json-patch+json

{"fileName": "string",
"base64Content": "string"
}

Response samples

200
400

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileName": "string"
}

通知服務

發送個人通知

Version： 1.0

金鑰權限要求： 其他 > 通知

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Request Body schema:
application/json-patch+json

required	object (SendToModel) 接收者
title required	string or null 標題
message required	string or null 內容

Responses

Request samples

Payload

Content type

application/json-patch+json

{"to": {"userType": 0,
"userCode": "string",
"corpCode": "string"
},
"title": "string",
"message": "string"
}

Response samples

400

Content type

application/json

{"errorCode": "string",
"errorExpando": [{"error": "string",
"expandoObject": null
}
],
"traceId": "string"
}

OAuthTest

公開 API - 無需驗證

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

測試OAuth驗證

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

Responses

測試 JWT 驗證

Authorizations:

Bearer

path Parameters

version

required

string

header Parameters

Api-Key	string API 金鑰 (選填)
App-Id	string App 識別碼 (選填)
CorpCode	string 公司代碼 (選填)

U-Office Force X OpenApi 手冊

Ede.Uofx.Api.OpenApi (1.0.0)

部門管理

取得公司全部部門資料

Authorizations:

path Parameters

header Parameters

Responses

Response samples

建立部門

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

更新部門資料

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

取得部門資料

Authorizations:

path Parameters

header Parameters

Responses

Response samples

更新部門狀態

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

刪除部門資料

Authorizations:

path Parameters

header Parameters

Responses

Response samples

移動部門

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

批次異動部門

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

部門人員管理

取得公司所有的員工資料

Authorizations:

path Parameters

header Parameters

Responses

Response samples

取得部門底下的員工資料

Authorizations:

path Parameters

header Parameters

Responses

Response samples

部門主管管理

移除部門主管

Authorizations:

path Parameters

header Parameters

Responses

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json