# Portal PORTAL API Field Map

Condensed from YH docs: 《推送待办消息接口说明》《消息通知推动接口说明》.
Customer environments may change hosts; field semantics stay stable.

## Common

- Method: POST JSON
- Auth: HTTP Basic
- Envelope: `esbInfo` + `requestInfo`
- Success: `esbInfo.returnStatus = "S"`
- Volume: 1 record per call; SLA ~30s; failure → re-push

Hosts (玉湖 example):

| Env | Base |
|-----|------|
| Dev | `http://esb-dev.iyuhu.com:9191` |
| UAT | `http://esb-test.iyuhu.com:9191` |
| Prod | `http://esb.iyuhu.com:9191` |

---

## PORTAL-002 addFlow — 新增流程+待办

Path: `/v1/portal/api/addFlow` · operatorType **1**

| Field | Required | Notes |
|-------|----------|-------|
| instanceId | Y | Unique per systemCode |
| systemCode | Y | Registered with portal |
| owerId | Y | IDM userCode of initiator |
| flowStartDate | Y | `yyyy-MM-dd HH:mm:ss` |
| title | Y | |
| flowStatus | Y | `approving` on create |
| flowType / flowTypeName | Y | Process type code/name |
| pcTaskUrl / mobileTaskUrl | Y | Header "我发起的" links |
| taskList[].taskId | Y | Unique; SHR assignId |
| taskList[].taskApproveId/Name | Y | IDM userCode + name |
| taskList[].taskArriveDate | Y | |
| taskList[].pcTaskUrl / mobileTaskUrl | Y | Todo card links |
| todoType / positionCode | N | |

---

## PORTAL-006 updateAgency — 待办转已办

Path: `/v1/portal/api/updateAgency` · operatorType **4**

| Field | Required |
|-------|----------|
| taskId, instanceId, systemCode | Y |
| taskApproveId, taskApproveName | Y |
| taskArriveDate, taskDoneDate | Y |
| pcTaskUrl, mobileTaskUrl | Y |

---

## PORTAL-007 deleteAgency — 删除待办

Path: `/v1/portal/api/deleteAgency` · operatorType **3**

| Field | Required | Notes |
|-------|----------|-------|
| instanceId, systemCode | Y | |
| taskIdList | Y | Comma-separated; **cannot reuse** after delete |
| operatorType | Y | 3 |

---

## PORTAL-003 updateFlow — 流程更新

Path: `/v1/portal/api/updateFlow` · operatorType **2**

| flowStatus | Portal meaning |
|------------|----------------|
| approving | In progress; may add new tasks |
| complete | Done — terminal |
| cancel | Void — terminal |
| delete | Deleted — terminal |
| refuse | Rejected |
| revoke | Revoked |
| draft | Draft |

**Before terminal status:** clear todos via 006 or 007. Terminal instanceId must not receive further updates.

Key fields: instanceId, systemCode, owerId, title, flowStatus, flowType, flowStartDate, pc/mobile URLs; taskList optional when approving.

---

## PORTAL-011 toBeRead — 新增待阅

Path: `/v1/portal/api/toBeRead` · operationType **0**

| Field | Required | Notes |
|-------|----------|-------|
| title, systemCode, systemName | Y | |
| employeeCode/Name | Y | Receiver IDM userCode |
| ownerCode/Name | Y | Display sender |
| url, mobileUrl | Y | |
| viewId | Y | Int; unique under systemCode |
| type, typeName | Y | Module on portal UI |
| sendDingFlag | N | 0/1 |
| instanceId | N | Empty string OK |

---

## PORTAL-012 toBeReadTransferredToRead — 待阅转已阅

Path: `/v1/portal/api/toBeReadTransferredToRead` · operationType **1**

Required: systemCode, employeeCode, viewId, type, operationType=1

---

## PORTAL-013 deleteToBeRead — 删除待阅

Path: `/v1/portal/api/deleteToBeRead` · operationType **2**

Required: systemCode, employeeCode, viewId, type, operationType=2